GetMedia

$result = $client->getMedia([/* ... */]);
$promise = $client->getMediaAsync([/* ... */]);

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number.

When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see PutMedia. The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request.

The following limits apply when using the GetMedia API:

• A client can call GetMedia up to five times per second per stream.

• Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

Parameter Syntax

$result = $client->getMedia([
    'StartSelector' => [ // REQUIRED
        'AfterFragmentNumber' => '<string>',
        'ContinuationToken' => '<string>',
        'StartSelectorType' => 'FRAGMENT_NUMBER|SERVER_TIMESTAMP|PRODUCER_TIMESTAMP|NOW|EARLIEST|CONTINUATION_TOKEN', // REQUIRED
        'StartTimestamp' => <integer || string || DateTime>,
    ],
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContentType' => '<string>',
    'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

ResourceNotFoundException:

Status Code: 404, The stream with the given name does not exist.

NotAuthorizedException:

Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

InvalidEndpointException:

Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia call.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ConnectionLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.

InvalidArgumentException:

The value for this input parameter is invalid.