AWS.Tools.KinesisVideoMedia.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.KinesisVideoMedia</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KVM.GetKVMMediaCmdlet"> <summary> 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. <note><para> You must first call the <code>GetDataEndpoint</code> API to get an endpoint. Then send the <code>GetMedia</code> requests to this endpoint using the <a href="https://docs.aws.amazon.com/cli/latest/reference/">--endpoint-url parameter</a>. </para></note><para> 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 <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html">PutMedia</a>. The <code>GetMedia</code> API returns a stream of these chunks starting from the chunk that you specify in the request. </para><para> The following limits apply when using the <code>GetMedia</code> API: </para><ul><li><para> A client can call <code>GetMedia</code> up to five times per second per stream. </para></li><li><para> Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a <code>GetMedia</code> session. </para></li></ul><note><para> If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: </para><ul><li><para><code>x-amz-ErrorType</code> HTTP header – contains a more specific error type in addition to what the HTTP status code provides. </para></li><li><para><code>x-amz-RequestId</code> HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. </para></li></ul><para> Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. </para><para> For more information, see the <b>Errors</b> section at the bottom of this topic, as well as <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html">Common Errors</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVM.GetKVMMediaCmdlet.StartSelector"> <summary> <para> <para>Identifies the starting chunk to get from the specified stream. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVM.GetKVMMediaCmdlet.StreamARN"> <summary> <para> <para>The ARN of the stream from where you want to get the media content. If you don't specify the <code>streamARN</code>, you must specify the <code>streamName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVM.GetKVMMediaCmdlet.StreamName"> <summary> <para> <para>The Kinesis video stream name from where you want to get the media content. If you don't specify the <code>streamName</code>, you must specify the <code>streamARN</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVM.GetKVMMediaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideoMedia.Model.GetMediaResponse). Specifying the name of a property of type Amazon.KinesisVideoMedia.Model.GetMediaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVM.GetKVMMediaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StartSelector parameter. The -PassThru parameter is deprecated, use -Select '^StartSelector' instead. This parameter will be removed in a future version. </summary> </member> </members> </doc> |