MediaConnect / Client / describe_flow_source_metadata

describe_flow_source_metadata

MediaConnect.Client.describe_flow_source_metadata(**kwargs)

The DescribeFlowSourceMetadata API is used to view information about the flow’s source transport stream and programs. This API displays status messages about the flow’s source as well as details about the program’s video, audio, and other data.

See also: AWS API Documentation

Request Syntax

response = client.describe_flow_source_metadata(
    FlowArn='string'
)
Parameters:

FlowArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the flow.

Return type:

dict

Returns:

Response Syntax

{
    'FlowArn': 'string',
    'Messages': [
        {
            'Code': 'string',
            'Message': 'string',
            'ResourceName': 'string'
        },
    ],
    'Timestamp': datetime(2015, 1, 1),
    'TransportMediaInfo': {
        'Programs': [
            {
                'PcrPid': 123,
                'ProgramName': 'string',
                'ProgramNumber': 123,
                'ProgramPid': 123,
                'Streams': [
                    {
                        'Channels': 123,
                        'Codec': 'string',
                        'FrameRate': 'string',
                        'FrameResolution': {
                            'FrameHeight': 123,
                            'FrameWidth': 123
                        },
                        'Pid': 123,
                        'SampleRate': 123,
                        'SampleSize': 123,
                        'StreamType': 'string'
                    },
                ]
            },
        ]
    },
    'NdiInfo': {
        'ActiveSource': {
            'SourceName': 'string'
        },
        'DiscoveredSources': [
            {
                'SourceName': 'string'
            },
        ],
        'MediaInfo': {
            'Streams': [
                {
                    'StreamType': 'string',
                    'Codec': 'string',
                    'StreamId': 123,
                    'ScanMode': 'progressive'|'interlace'|'progressive-segmented-frame',
                    'FrameResolution': {
                        'FrameHeight': 123,
                        'FrameWidth': 123
                    },
                    'FrameRate': 'string',
                    'Channels': 123,
                    'SampleRate': 123
                },
            ]
        },
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string',
                'ResourceName': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • FlowArn (string) –

      The ARN of the flow that DescribeFlowSourceMetadata was performed on.

    • Messages (list) –

      Provides a status code and message regarding issues found with the flow source metadata.

      • (dict) –

        The details of an error message.

        • Code (string) –

          The error code.

        • Message (string) –

          The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

        • ResourceName (string) –

          The name of the resource.

    • Timestamp (datetime) –

      The timestamp of the most recent change in metadata for this flow’s source.

    • TransportMediaInfo (dict) –

      Information about the flow’s transport media.

      • Programs (list) –

        The list of transport stream programs in the current flow’s source.

        • (dict) –

          The metadata of a single transport stream program.

          • PcrPid (integer) –

            The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table.

          • ProgramName (string) –

            The program name as it is reported in the Program Association Table.

          • ProgramNumber (integer) –

            The program number as it is reported in the Program Association Table.

          • ProgramPid (integer) –

            The program Packet ID (PID) as it is reported in the Program Association Table.

          • Streams (list) –

            The list of elementary transport streams in the program. The list includes video, audio, and data streams.

            • (dict) –

              The metadata of an elementary transport stream.

              • Channels (integer) –

                The number of channels in the audio stream.

              • Codec (string) –

                The codec used by the stream.

              • FrameRate (string) –

                The frame rate used by the video stream.

              • FrameResolution (dict) –

                The frame resolution used by the video stream.

                • FrameHeight (integer) –

                  The number of pixels in the height of the video frame.

                • FrameWidth (integer) –

                  The number of pixels in the width of the video frame.

              • Pid (integer) –

                The Packet ID (PID) as it is reported in the Program Map Table.

              • SampleRate (integer) –

                The sample rate used by the audio stream.

              • SampleSize (integer) –

                The sample bit size used by the audio stream.

              • StreamType (string) –

                The Stream Type as it is reported in the Program Map Table.

    • NdiInfo (dict) –

      The NDI® specific information about the flow’s source. This includes the current active NDI sender, a list of all discovered NDI senders, the associated media streams for the active NDI sender, and any relevant status messages.

      • ActiveSource (dict) –

        The connected NDI sender that’s currently sending source content to the flow’s NDI source.

        • SourceName (string) –

          The name of the upstream NDI sender.

      • DiscoveredSources (list) –

        A list of the available upstream NDI senders aggregated from all of your configured discovery servers.

        • (dict) –

          Information about a single NDI® sender, including its name.

          • SourceName (string) –

            The name of the upstream NDI sender.

      • MediaInfo (dict) –

        Detailed information about the media streams (video, audio, and so on) that are part of the active NDI source.

        • Streams (list) –

          A list of the individual media streams that make up the NDI source. This includes details about each stream’s codec, resolution, frame rate, audio channels, and other parameters.

          • (dict) –

            Detailed information about a single media stream that is part of an NDI® source. This includes details about the stream type, codec, resolution, frame rate, audio channels, and sample rate.

            • StreamType (string) –

              The type of media stream (for example, Video or Audio).

            • Codec (string) –

              The codec used for the media stream. For NDI sources, use speed-hq.

            • StreamId (integer) –

              A unique identifier for the media stream.

            • ScanMode (string) –

              The method used to display video frames. Used when the streamType is Video.

            • FrameResolution (dict) –

              The width and height dimensions of the video frame in pixels. Used when the streamType is Video.

              • FrameHeight (integer) –

                The number of pixels in the height of the video frame.

              • FrameWidth (integer) –

                The number of pixels in the width of the video frame.

            • FrameRate (string) –

              The number of video frames displayed per second. Used when the streamType is Video.

            • Channels (integer) –

              The number of audio channels in the stream. Used when the streamType is Audio.

            • SampleRate (integer) –

              The number of audio samples captured per second, measured in kilohertz (kHz). Used when the streamType is Audio.

      • Messages (list) –

        Any status messages or error codes related to the NDI source and its metadata.

        • (dict) –

          The details of an error message.

          • Code (string) –

            The error code.

          • Message (string) –

            The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

          • ResourceName (string) –

            The name of the resource.

Exceptions