MPEGTS Audio Descriptors

Audio Component Descriptor

Identifies the type of component stream and may be used to provide a text description of the elementary stream.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>addMedia</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format> <!-- required -->
        <output>mpegts</output> <!-- required -->
        <audio_component_descriptor>
            <stream_content>[StreamType]</stream_content>
            <component_type>[ComponentType]</component_type>
            <component_tag>[ComponentTag]</component_tag>
            <language_code>[LanguageCode]</language_code>
            <text>[Text]</text>
        </audio_component_descriptor>
        <audio_stream>
            <audio_component_descriptor>
                <stream_content>[StreamType]</stream_content>
                <component_type>[ComponentType]</component_type>
                <component_tag>[ComponentTag]</component_tag>
                <language_code>[LanguageCode]</language_code>
                <text>[Text]</text>
            </audio_component_descriptor>
            <!-- audio_stream params -->
        </audio_stream>
        <audio_stream>
            <!-- audio_stream params -->
        </audio_stream>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "mpegts", // required
            "audio_component_descriptor": {
                "stream_content": "[StreamType]",
                "component_type": "[ComponentType]",
                "component_tag": "[ComponentTag]",
                "language_code": "[LanguageCode]",
                "text": "[Text]"
            },
            "audio_stream": [
                {
                    "audio_component_descriptor": {
                        "stream_content": "[StreamType]",
                        "component_type": "[ComponentType]",
                        "component_tag": "[ComponentTag]",
                        "language_code": "[LanguageCode]",
                        "text": "[Text]"
                    },
                    // audio_stream params
                },
                {
                    // audio_stream params
                }
            ]
        }
    }
}

Parameter

Description

Allowed Value

Default Value

stream_content

Specifies the type of stream

Positive integer number

none

component_type

Specifies the type of the component

Positive integer number

none

component_tag

Component tag

Positive integer number

none

language_code

Language of the component

Valid ISO 639 language code

none

text

Text description of the component stream

String

none

Supplementary Audio Descriptor

Provides additional information about the audio streams which allows the receiver to present the appropriate stream, or mix of streams, to the user.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>addMedia</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format> <!-- required -->
        <output>mpegts</output> <!-- required -->
        <supplementary_audio_descriptor>
            <mix_type>[0|1]</mix_type>
            <editorial_classification>[Classification]</editorial_classification>
            <language_code>[LanguageCode]</language_code>
        </supplementary_audio_descriptor>
        <audio_stream>
            <supplementary_audio_descriptor>
                <mix_type>[0|1]</mix_type>
                <editorial_classification>[Classification]</editorial_classification>
                <language_code>[LanguageCode]</language_code>
            </supplementary_audio_descriptor>
            <!-- audio_stream params -->
        </audio_stream>
        <audio_stream>
            <!-- audio_stream params -->
        </audio_stream>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "mpegts", // required
            "supplementary_audio_descriptor": {
                "mix_type": "[0|1]",
                "editorial_classification": "[Classification]",
                "language_code": "[LanguageCode]"
            },
            "audio_stream": [
                {
                    "supplementary_audio_descriptor": {
                        "mix_type": "[0|1]",
                        "editorial_classification": "[Classification]",
                        "language_code": "[LanguageCode]"
                    },
                    // audio_stream params
                },
                {
                    // audio_stream params
                }
            ]
        }
    }
}

Parameter

Description

Allowed Value

Default Value

mix_type

Indicates whether the audio stream is a complete and independent stream or whether it is a
supplementary stream intended to be mixed with another audio stream

0 – Audio stream is a supplementary stream
1 – Audio stream is a complete and independent stream

none

editorial_classification

Indicates the editorial intention of the audio stream

0 – Main audio
1 – Audio description for the visually impaired
3 – Spoken subtitles for the visually impaired
other values – user defined.

none

language_code

Language of the component

Valid ISO 639 language code

none