07 July 2022

Custom CUE point tags

Added ability to insert custom CUE points tags into HLS output formats.
Also added option to prevent video stream segmentation in given CUE point.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format>
        <output>[advanced_hls|fmp4_hls|advanced_fmp4|advanced_dash]</output>
        <!-- multiple cue_inserts may be included -->
        <cue_insert>
            <marker_type>custom-tag</marker_type>
            <custom_tag>[CustomTag]</custom_tag>
            <add_video_keyframe>[yes|no]</add_video_keyframe>
           	<!-- cue_insert params -->
        </cue_insert>
        <cue_insert>
           	<!-- cue_insert params -->
        </cue_insert>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[Action]", //  // requiredrequired
        "source": "[SourceFile]",
        "format": { // required
            "output": "[advanced_hls|fmp4_hls|advanced_fmp4|advanced_dash]",
            "cue_insert": [
                {
                    "marker_type": "custom-tag",
                    "custom_tag": "[CustomTag]",
                    "add_video_keyframe": "[yes|no]"
                    // cue_insert params
                },
                {
                    // cue_insert params
                }
            ]
        }
    }
}

Parameter

Description

Allowed Values

Default Value

  • *marker_type** (cue_insert)

Break Marker Type

  • *For advanced_dash:
    • 
    scte35-opening-credit** – adds *<scte35:signal />*opening credits block.
    • scte35-closing-credit – adds *<scte35:signal />*closing credits block.
    • scte35-chapter-marker – adds *<scte35:signal />*chapter marker block.
    • scte35-content-identification – adds *<scte35:signal />* content identification block.

  • *For advanced_hls, fmp4_hls, advanced_fmp4:
    • 
    scte35-opening-credit** – adds #EXT-X-SCTE35opening credits tag.
    • scte35-closing-credit – adds #EXT-X-SCTE35closing credits tag.
    • scte35-chapter-marker – adds #EXT-X-SCTE35chapter marker tag.
    • scte35-content-identification – adds #EXT-X-SCTE35content identification tag.
    • scte35-provider-overlay – adds #EXT-X-SCTE35provider overlay placement opportunity data.
    • custom-tag – adds custom CUE point tag specified in *<scte35:custom_tag />* parameter.

cue-out-in

custom_tag

Value of custom cue_insert with "custom-tag" marker_type.

Valid HLS m3u8 tag

none

add_video_keyframe

Segment video stream at given CUE point

yes, no

yes

🚧

For custom-tag marker_type and custom_tag parameter

  • The <marker_type /> value custom-tag available only for <cue_insert /> of HLS output formats.
  • The <custom_tag /> parameter is required for <cue_insert /> if <marker_type /> set to custom-tag.