internal virtual GetDASHStreamingSessionURLResponse GetDASHStreamingSessionURL(GetDASHStreamingSessionURLRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDASHStreamingSessionURLRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDASHStreamingSessionURLResponseUnmarshaller.Instance;
return(Invoke <GetDASHStreamingSessionURLResponse>(request, options));
}
/// <summary>
/// Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream.
/// You can then open the URL in a media player to view the stream contents.
///
///
/// <para>
/// Both the <code>StreamName</code> and the <code>StreamARN</code> parameters are optional,
/// but you must specify either the <code>StreamName</code> or the <code>StreamARN</code>
/// when invoking this API operation.
/// </para>
///
/// <para>
/// An Amazon Kinesis video stream has the following requirements for providing data through
/// MPEG-DASH:
/// </para>
/// <ul> <li>
/// <para>
/// The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711
/// encoded audio. Specifically, the codec id of track 1 should be <code>V_MPEG/ISO/AVC</code>
/// (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec id of track 2 should
/// be <code>A_AAC</code> (for AAC) or A_MS/ACM (for G.711).
/// </para>
/// </li> <li>
/// <para>
/// Data retention must be greater than 0.
/// </para>
/// </li> <li>
/// <para>
/// The video track of each fragment must contain codec private data in the Advanced Video
/// Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see
/// <a href="https://www.iso.org/standard/55980.html">MPEG-4 specification ISO/IEC 14496-15</a>.
/// For information about adapting stream data to a given format, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html">NAL
/// Adaptation Flags</a>.
/// </para>
/// </li> <li>
/// <para>
/// The audio track (if present) of each fragment must contain codec private data in the
/// AAC format (<a href="https://www.iso.org/standard/43345.html">AAC specification ISO/IEC
/// 13818-7</a>) or the <a href="http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html">MS
/// Wave format</a>.
/// </para>
/// </li> </ul>
/// <para>
/// The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:
/// </para>
/// <ol> <li>
/// <para>
/// Get an endpoint using <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html">GetDataEndpoint</a>,
/// specifying <code>GET_DASH_STREAMING_SESSION_URL</code> for the <code>APIName</code>
/// parameter.
/// </para>
/// </li> <li>
/// <para>
/// Retrieve the MPEG-DASH URL using <code>GetDASHStreamingSessionURL</code>. Kinesis
/// Video Streams creates an MPEG-DASH streaming session to be used for accessing content
/// in a stream using the MPEG-DASH protocol. <code>GetDASHStreamingSessionURL</code>
/// returns an authenticated URL (that includes an encrypted session token) for the session's
/// MPEG-DASH <i>manifest</i> (the root resource needed for streaming with MPEG-DASH).
/// </para>
/// <note>
/// <para>
/// Don't share or store this token where an unauthorized entity could access it. The
/// token provides access to the content of the stream. Safeguard the token with the same
/// measures that you would use with your AWS credentials.
/// </para>
/// </note>
/// <para>
/// The media that is made available through the manifest consists only of the requested
/// stream, time range, and format. No other media data (such as frames outside the requested
/// window or alternate bitrates) is made available.
/// </para>
/// </li> <li>
/// <para>
/// Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest
/// to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes
/// the initialization fragment, and media fragments available through the manifest URL.
/// The initialization fragment contains the codec private data for the stream, and other
/// data needed to set up the video or audio decoder and renderer. The media fragments
/// contain encoded video frames or encoded audio samples.
/// </para>
/// </li> <li>
/// <para>
/// The media player receives the authenticated URL and requests stream metadata and media
/// data normally. When the media player requests data, it calls the following actions:
/// </para>
/// <ul> <li>
/// <para>
/// <b>GetDASHManifest:</b> Retrieves an MPEG DASH manifest, which contains the metadata
/// for the media that you want to playback.
/// </para>
/// </li> <li>
/// <para>
/// <b>GetMP4InitFragment:</b> Retrieves the MP4 initialization fragment. The media player
/// typically loads the initialization fragment before loading any media fragments. This
/// fragment contains the "<code>fytp</code>" and "<code>moov</code>" MP4 atoms, and the
/// child atoms that are needed to initialize the media player decoder.
/// </para>
///
/// <para>
/// The initialization fragment does not correspond to a fragment in a Kinesis video stream.
/// It contains only the codec private data for the stream and respective track, which
/// the media player needs to decode the media frames.
/// </para>
/// </li> <li>
/// <para>
/// <b>GetMP4MediaFragment:</b> Retrieves MP4 media fragments. These fragments contain
/// the "<code>moof</code>" and "<code>mdat</code>" MP4 atoms and their child atoms, containing
/// the encoded fragment's media frames and their timestamps.
/// </para>
/// <note>
/// <para>
/// After the first media fragment is made available in a streaming session, any fragments
/// that don't contain the same codec private data cause an error to be returned when
/// those different media fragments are loaded. Therefore, the codec private data should
/// not change between fragments in a session. This also means that the session fails
/// if the fragments in a stream change from having only video to having both audio and
/// video.
/// </para>
/// </note>
/// <para>
/// Data retrieved with this action is billable. See <a href="https://aws.amazon.com/kinesis/video-streams/pricing/">Pricing</a>
/// for details.
/// </para>
/// </li> </ul> </li> </ol> <note>
/// <para>
/// The following restrictions apply to MPEG-DASH sessions:
/// </para>
/// <ul> <li>
/// <para>
/// A streaming session URL should not be shared between players. The service might throttle
/// a session if multiple media players are sharing it. For connection limits, see <a
/// href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis
/// Video Streams Limits</a>.
/// </para>
/// </li> <li>
/// <para>
/// A Kinesis video stream can have a maximum of ten active MPEG-DASH streaming sessions.
/// If a new session is created when the maximum number of sessions is already active,
/// the oldest (earliest created) session is closed. The number of active <code>GetMedia</code>
/// connections on a Kinesis video stream does not count against this limit, and the number
/// of active MPEG-DASH sessions does not count against the active <code>GetMedia</code>
/// connection limit.
/// </para>
/// <note>
/// <para>
/// The maximum limits for active HLS and MPEG-DASH streaming sessions are independent
/// of each other.
/// </para>
/// </note> </li> </ul> </note>
/// <para>
/// You can monitor the amount of data that the media player consumes by monitoring the
/// <code>GetMP4MediaFragment.OutgoingBytes</code> Amazon CloudWatch metric. For information
/// about using CloudWatch to monitor Kinesis Video Streams, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html">Monitoring
/// Kinesis Video Streams</a>. For pricing information, see <a href="https://aws.amazon.com/kinesis/video-streams/pricing/">Amazon
/// Kinesis Video Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/">AWS
/// Pricing</a>. Charges for both HLS sessions and outgoing AWS data apply.
/// </para>
///
/// <para>
/// For more information about HLS, see <a href="https://developer.apple.com/streaming/">HTTP
/// Live Streaming</a> on the <a href="https://developer.apple.com">Apple Developer site</a>.
/// </para>
/// <important>
/// <para>
/// If an error is thrown after invoking a Kinesis Video Streams archived 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>
/// </important>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetDASHStreamingSessionURL service method.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
///
/// <returns>The response from the GetDASHStreamingSessionURL service method, as returned by KinesisVideoArchivedMedia.</returns>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.ClientLimitExceededException">
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
/// </exception>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.InvalidArgumentException">
/// A specified parameter exceeds its restrictions, is not supported, or can't be used.
/// </exception>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.InvalidCodecPrivateDataException">
/// The codec private data in at least one of the tracks of the video stream is not valid
/// for this operation.
/// </exception>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.MissingCodecPrivateDataException">
/// No codec private data was found in at least one of tracks of the video stream.
/// </exception>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.NoDataRetentionException">
/// A streaming session was requested for a stream that does not retain data (that is,
/// has a <code>DataRetentionInHours</code> of 0).
/// </exception>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.NotAuthorizedException">
/// Status Code: 403, The caller is not authorized to perform an operation on the given
/// stream, or the token has expired.
/// </exception>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.ResourceNotFoundException">
/// <code>GetMedia</code> throws this error when Kinesis Video Streams can't find the
/// stream that you specified.
///
///
/// <para>
/// <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code>
/// throw this error if a session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code>
/// or <code>LIVE_REPLAY</code>is requested for a stream that has no fragments within
/// the requested time range, or if a session with a <code>PlaybackMode</code> of <code>LIVE</code>
/// is requested for a stream that has no fragments within the last 30 seconds.
/// </para>
/// </exception>
/// <exception cref="Amazon.KinesisVideoArchivedMedia.Model.UnsupportedStreamMediaTypeException">
/// The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could
/// not be determined from the codec IDs of the tracks in the first fragment for a playback
/// session. The codec ID for track 1 should be <code>V_MPEG/ISO/AVC</code> and, optionally,
/// the codec ID for track 2 should be <code>A_AAC</code>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetDASHStreamingSessionURL">REST API Reference for GetDASHStreamingSessionURL Operation</seealso>
public virtual Task <GetDASHStreamingSessionURLResponse> GetDASHStreamingSessionURLAsync(GetDASHStreamingSessionURLRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDASHStreamingSessionURLRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDASHStreamingSessionURLResponseUnmarshaller.Instance;
return(InvokeAsync <GetDASHStreamingSessionURLResponse>(request, options, cancellationToken));
}
