#[non_exhaustive]pub struct GetMediaOutputBuilder { /* private fields */ }
Expand description
A builder for GetMediaOutput
.
Implementations§
source§impl GetMediaOutputBuilder
impl GetMediaOutputBuilder
sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
The content type of the requested media.
sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
The content type of the requested media.
sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
The content type of the requested media.
sourcepub fn payload(self, input: ByteStream) -> Self
pub fn payload(self, input: ByteStream) -> Self
The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia
call also include the following additional Matroska (MKV) tags:
-
AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your
GetMedia
call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. -
AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.
-
AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
-
AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.
-
AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.
The following tags will be present if an error occurs:
-
AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.
-
AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.
The error codes are as follows:
-
3002 - Error writing to the stream
-
4000 - Requested fragment is not found
-
4500 - Access denied for the stream's KMS key
-
4501 - Stream's KMS key is disabled
-
4502 - Validation error on the stream's KMS key
-
4503 - KMS key specified in the stream is unavailable
-
4504 - Invalid usage of the KMS key specified in the stream
-
4505 - Invalid state of the KMS key specified in the stream
-
4506 - Unable to find the KMS key specified in the stream
-
5000 - Internal error
sourcepub fn set_payload(self, input: Option<ByteStream>) -> Self
pub fn set_payload(self, input: Option<ByteStream>) -> Self
The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia
call also include the following additional Matroska (MKV) tags:
-
AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your
GetMedia
call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. -
AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.
-
AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
-
AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.
-
AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.
The following tags will be present if an error occurs:
-
AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.
-
AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.
The error codes are as follows:
-
3002 - Error writing to the stream
-
4000 - Requested fragment is not found
-
4500 - Access denied for the stream's KMS key
-
4501 - Stream's KMS key is disabled
-
4502 - Validation error on the stream's KMS key
-
4503 - KMS key specified in the stream is unavailable
-
4504 - Invalid usage of the KMS key specified in the stream
-
4505 - Invalid state of the KMS key specified in the stream
-
4506 - Unable to find the KMS key specified in the stream
-
5000 - Internal error
sourcepub fn get_payload(&self) -> &Option<ByteStream>
pub fn get_payload(&self) -> &Option<ByteStream>
The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia
call also include the following additional Matroska (MKV) tags:
-
AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your
GetMedia
call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. -
AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.
-
AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
-
AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.
-
AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.
The following tags will be present if an error occurs:
-
AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.
-
AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.
The error codes are as follows:
-
3002 - Error writing to the stream
-
4000 - Requested fragment is not found
-
4500 - Access denied for the stream's KMS key
-
4501 - Stream's KMS key is disabled
-
4502 - Validation error on the stream's KMS key
-
4503 - KMS key specified in the stream is unavailable
-
4504 - Invalid usage of the KMS key specified in the stream
-
4505 - Invalid state of the KMS key specified in the stream
-
4506 - Unable to find the KMS key specified in the stream
-
5000 - Internal error
sourcepub fn build(self) -> GetMediaOutput
pub fn build(self) -> GetMediaOutput
Consumes the builder and constructs a GetMediaOutput
.
Trait Implementations§
source§impl Debug for GetMediaOutputBuilder
impl Debug for GetMediaOutputBuilder
source§impl Default for GetMediaOutputBuilder
impl Default for GetMediaOutputBuilder
source§fn default() -> GetMediaOutputBuilder
fn default() -> GetMediaOutputBuilder
Auto Trait Implementations§
impl !Freeze for GetMediaOutputBuilder
impl !RefUnwindSafe for GetMediaOutputBuilder
impl Send for GetMediaOutputBuilder
impl Sync for GetMediaOutputBuilder
impl Unpin for GetMediaOutputBuilder
impl !UnwindSafe for GetMediaOutputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more