MediaConnect / Client / get_router_input_source_metadata

get_router_input_source_metadata

MediaConnect.Client.get_router_input_source_metadata(**kwargs)

Retrieves detailed metadata information about a specific router input source, including stream details and connection state.

See also: AWS API Documentation

Request Syntax

response = client.get_router_input_source_metadata(
    Arn='string'
)

Parameters:

Arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the router input to retrieve metadata for.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'SourceMetadataDetails': {
        'SourceMetadataMessages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'Timestamp': datetime(2015, 1, 1),
        'RouterInputMetadata': {
            'TransportStreamMediaInfo': {
                '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) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the router input.

  • Name (string) –

    The name of the router input.

  • SourceMetadataDetails (dict) –

    Detailed metadata information about the router input source, including connection state, timestamps, and stream configuration.

    • SourceMetadataMessages (list) –

      Collection of metadata messages associated with the router input source.

      • (dict) –

        A message associated with a router input, including a code and a message.

        • Code (string) –

          The code associated with the router input message.

        • Message (string) –

          The message text associated with the router input message.

    • Timestamp (datetime) –

      The timestamp when the metadata was last updated.

    • RouterInputMetadata (dict) –

      Metadata information specific to the router input configuration and state.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: TransportStreamMediaInfo. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

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

Exceptions

• MediaConnect.Client.exceptions.BadRequestException

• MediaConnect.Client.exceptions.TooManyRequestsException

• MediaConnect.Client.exceptions.ForbiddenException

• MediaConnect.Client.exceptions.InternalServerErrorException

• MediaConnect.Client.exceptions.NotFoundException

• MediaConnect.Client.exceptions.ServiceUnavailableException