@datafire/amazonaws_kinesis_video_media
v5.0.0
Published
DataFire integration for Amazon Kinesis Video Streams Media
Downloads
3
Readme
@datafire/amazonaws_kinesis_video_media
Client library for Amazon Kinesis Video Streams Media
Installation and Usage
npm install --save @datafire/amazonaws_kinesis_video_media
let amazonaws_kinesis_video_media = require('@datafire/amazonaws_kinesis_video_media').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_kinesis_video_media.GetMedia({
"StartSelector": {
"StartSelectorType": ""
}
}).then(data => {
console.log(data);
});
Description
Actions
GetMedia
amazonaws_kinesis_video_media.GetMedia({
"StartSelector": {
"StartSelectorType": ""
}
}, context)
Input
- input
object
- StartSelector required StartSelector
- StreamARN ResourceARN
- StreamName StreamName
Output
- output GetMediaOutput
Definitions
ClientLimitExceededException
- ClientLimitExceededException
object
: Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.- Message ErrorMessage
ConnectionLimitExceededException
- ConnectionLimitExceededException
object
: Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.- Message ErrorMessage
ContentType
- ContentType
string
ContinuationToken
- ContinuationToken
string
ErrorMessage
- ErrorMessage
string
FragmentNumberString
- FragmentNumberString
string
GetMediaInput
- GetMediaInput
object
- StartSelector required StartSelector
- StreamARN ResourceARN
- StreamName StreamName
GetMediaOutput
- GetMediaOutput
object
- Payload Payload
InvalidArgumentException
- InvalidArgumentException
object
: The value for this input parameter is invalid.- Message ErrorMessage
InvalidEndpointException
- InvalidEndpointException
object
: 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.- Message ErrorMessage
NotAuthorizedException
- NotAuthorizedException
object
: Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.- Message ErrorMessage
Payload
- Payload
string
ResourceARN
- ResourceARN
string
ResourceNotFoundException
- ResourceNotFoundException
object
: Status Code: 404, The stream with the given name does not exist.- Message ErrorMessage
StartSelector
- StartSelector
object
: Identifies the chunk on the Kinesis video stream where you want the GetMedia API to start returning media data. You have the following options to identify the starting chunk: Choose the latest (or oldest) chunk. Identify a specific chunk. You can identify a specific chunk either by providing a fragment number or time stamp (server or producer). Each chunk's metadata includes a continuation token as a Matroska (MKV) tag (AWS_KINESISVIDEO_CONTINUATION_TOKEN). If your previous GetMedia request terminated, you can use this tag value in your next GetMedia request. The API then starts returning chunks starting where the last API ended.- AfterFragmentNumber FragmentNumberString
- ContinuationToken ContinuationToken
- StartSelectorType required StartSelectorType
- StartTimestamp Timestamp
StartSelectorType
- StartSelectorType
string
(values: FRAGMENT_NUMBER, SERVER_TIMESTAMP, PRODUCER_TIMESTAMP, NOW, EARLIEST, CONTINUATION_TOKEN)
StreamName
- StreamName
string
Timestamp
- Timestamp
string