Messages Programs Streams URI HTTP methods Schemas Properties See also

Flow source metadata: describe

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.

The following sections contain details of the information provided by DescribeFlowSourceMetadata.

Messages

The messages section of the DescribeFlowSourceMetadata response can contain status codes with more information about the transport stream. If MediaConnect detects an issue or cannot retrieve the source stream metadata, an associated status code and message will be displayed.

Programs

The programs section of the DescribeFlowSourceMetadata response contains information about each program in the transport stream.

Field	Details
`ProgramNumber`	The program number of this program.
`ProgramPid`	The program Packet Identifier (PID).
`PcrPid`	The Program Clock Reference (PCR) PID of this program.
`ProgramName`	The name of this program.
`Streams`	The nested sections contain info about the video, audio, and data stream types.

Streams

The streams section of the DescribeFlowSourceMetadata response contains information about the video, audio, and data streams of each program. The streams section is found within the programs section of the response.

Field	Details
`StreamType`	The type of content that this stream contains. This value can be video, audio, data, or unknown.
`Codec`	The codec of the stream. This value will vary depending on the type of stream. For example, a video stream type might display a H264 value while an audio stream type displays AAC.
`Pid`	The Packet Identifier (PID) of the stream.

URI

/v1/flows/flowArn/source-metadata

HTTP methods

GET

Operation ID: DescribeFlowSourceMetadata

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.

Responses
Status code	Response model	Description
`200`	`DescribeFlowSourceMetadataResponse`	MediaConnect returned the flow details successfully.
`400`	`ResponseError`	The request that you submitted is not valid.
`403`	`ResponseError`	You don't have the required permissions to perform this operation.
`404`	`ResponseError`	MediaConnect did not find the resource that you specified in the request.
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

Schemas

Response bodies


{
  "flowArn": "string",
  "messages": [
    {
      "code": "string",
      "resourceName": "string",
      "message": "string"
    }
  ],
  "transportMediaInfo": {
    "programs": [
      {
        "programName": "string",
        "programPid": integer,
        "streams": [
          {
            "codec": "string",
            "frameRate": "string",
            "streamType": "string",
            "channels": integer,
            "language": "string",
            "pid": integer,
            "sampleSize": integer,
            "sampleRate": integer,
            "timecodePresent": boolean,
            "frameResolution": {
              "frameHeight": integer,
              "frameWidth": integer
            }
          }
        ],
        "programNumber": integer,
        "pcrPid": integer
      }
    ]
  },
  "timestamp": "string"
}


{
  "message": "string"
}

Properties

DescribeFlowSourceMetadataResponse

The result of a successful DescribeFlowSourceMetadata request.

Property	Type	Required	Description
`flowArn`	string	True	The ARN of the flow that DescribeFlowSourceMetadata was performed on.
`messages`	Array of type MessageDetail	True	Provides a status code and message regarding issues found with the flow source metadata.
`timestamp`	string Format: date-time	True	The timestamp of the most recent change in metadata for this flow’s source.
`transportMediaInfo`	TransportMediaInfo	False

FrameResolution

The frame resolution used by the video stream.

Property	Type	Required	Description
`frameHeight`	integer	True	The number of pixels in the height of the video frame.
`frameWidth`	integer	True	The number of pixels in the width of the video frame.

MessageDetail

Property	Type	Required	Description
`code`	string	True	The error code.
`message`	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
`resourceName`	string	False	The name of the resource.

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property	Type	Required	Description
`message`	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

TransportMediaInfo

The metadata of the transport stream in the current flow's source.

Property	Type	Required	Description
`programs`	Array of type TransportStreamProgram	True	The list of transport stream programs in the current flow's source.

TransportStream

The metadata of an elementary transport stream.

Property	Type	Required	Description
`channels`	integer	False	The number of channels in the audio stream.
`codec`	string	False	The codec used by the stream.
`frameRate`	string	False	The frame rate used by the video stream.
`frameResolution`	FrameResolution	False
`language`	string	False	The language used by the audio or data stream.
`pid`	integer	True	The Packet ID (PID) as it is reported in the Program Map Table.
`sampleRate`	integer	False	The sample rate used by the audio stream.
`sampleSize`	integer	False	The sample bit size used by the audio stream.
`streamType`	string	True	The Stream Type as it is reported in the Program Map Table.
`timecodePresent`	boolean	False	Indicates if timecodes are present in the stream.

TransportStreamProgram

The metadata of a single transport stream program.

Property	Type	Required	Description
`pcrPid`	integer	True	The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table.
`programName`	string	False	The program name as it is reported in the Program Association Table.
`programNumber`	integer	True	The program number as it is reported in the Program Association Table.
`programPid`	integer	True	The program Packet ID (PID) as it is reported in the Program Association Table.
`streams`	Array of type TransportStream	True	The list of elementary transport streams in the program. The list includes video, audio, and data streams.