AWS MediaConnect

Displays details of the flow's source stream. The response contains information about the contents of the stream and its programs.

See also: AWS API Documentation

Request Syntax

client.describe_flow_source_metadata(
    FlowArn='string'
)

type FlowArn:

string

param FlowArn:

[REQUIRED] The Amazon Resource Name (ARN) of the flow.

rtype:

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'
                    },
                ]
            },
        ]
    }
}

Response Structure

• (dict) -- Flow source metadata successfully described.

  • 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) --

      • 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) -- The metadata of the transport stream in the current flow's source.

    • 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.