#[non_exhaustive]pub struct MediaCapturePipeline {
pub media_pipeline_id: Option<String>,
pub media_pipeline_arn: Option<String>,
pub source_type: Option<MediaPipelineSourceType>,
pub source_arn: Option<String>,
pub status: Option<MediaPipelineStatus>,
pub sink_type: Option<MediaPipelineSinkType>,
pub sink_arn: Option<String>,
pub created_timestamp: Option<DateTime>,
pub updated_timestamp: Option<DateTime>,
pub chime_sdk_meeting_configuration: Option<ChimeSdkMeetingConfiguration>,
pub sse_aws_key_management_params: Option<SseAwsKeyManagementParams>,
pub sink_iam_role_arn: Option<String>,
}
Expand description
A media pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.media_pipeline_id: Option<String>
The ID of a media pipeline.
media_pipeline_arn: Option<String>
The ARN of the media capture pipeline
source_type: Option<MediaPipelineSourceType>
Source type from which media artifacts are saved. You must use ChimeMeeting
.
source_arn: Option<String>
ARN of the source from which the media artifacts are saved.
status: Option<MediaPipelineStatus>
The status of the media pipeline.
sink_type: Option<MediaPipelineSinkType>
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
sink_arn: Option<String>
ARN of the destination to which the media artifacts are saved.
created_timestamp: Option<DateTime>
The time at which the pipeline was created, in ISO 8601 format.
updated_timestamp: Option<DateTime>
The time at which the pipeline was updated, in ISO 8601 format.
chime_sdk_meeting_configuration: Option<ChimeSdkMeetingConfiguration>
The configuration for a specified media pipeline. SourceType
must be ChimeSdkMeeting
.
sse_aws_key_management_params: Option<SseAwsKeyManagementParams>
An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.
sink_iam_role_arn: Option<String>
The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId
in SseAwsKeyManagementParams
.
Implementations§
Source§impl MediaCapturePipeline
impl MediaCapturePipeline
Sourcepub fn media_pipeline_id(&self) -> Option<&str>
pub fn media_pipeline_id(&self) -> Option<&str>
The ID of a media pipeline.
Sourcepub fn media_pipeline_arn(&self) -> Option<&str>
pub fn media_pipeline_arn(&self) -> Option<&str>
The ARN of the media capture pipeline
Sourcepub fn source_type(&self) -> Option<&MediaPipelineSourceType>
pub fn source_type(&self) -> Option<&MediaPipelineSourceType>
Source type from which media artifacts are saved. You must use ChimeMeeting
.
Sourcepub fn source_arn(&self) -> Option<&str>
pub fn source_arn(&self) -> Option<&str>
ARN of the source from which the media artifacts are saved.
Sourcepub fn status(&self) -> Option<&MediaPipelineStatus>
pub fn status(&self) -> Option<&MediaPipelineStatus>
The status of the media pipeline.
Sourcepub fn sink_type(&self) -> Option<&MediaPipelineSinkType>
pub fn sink_type(&self) -> Option<&MediaPipelineSinkType>
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
Sourcepub fn sink_arn(&self) -> Option<&str>
pub fn sink_arn(&self) -> Option<&str>
ARN of the destination to which the media artifacts are saved.
Sourcepub fn created_timestamp(&self) -> Option<&DateTime>
pub fn created_timestamp(&self) -> Option<&DateTime>
The time at which the pipeline was created, in ISO 8601 format.
Sourcepub fn updated_timestamp(&self) -> Option<&DateTime>
pub fn updated_timestamp(&self) -> Option<&DateTime>
The time at which the pipeline was updated, in ISO 8601 format.
Sourcepub fn chime_sdk_meeting_configuration(
&self,
) -> Option<&ChimeSdkMeetingConfiguration>
pub fn chime_sdk_meeting_configuration( &self, ) -> Option<&ChimeSdkMeetingConfiguration>
The configuration for a specified media pipeline. SourceType
must be ChimeSdkMeeting
.
Sourcepub fn sse_aws_key_management_params(
&self,
) -> Option<&SseAwsKeyManagementParams>
pub fn sse_aws_key_management_params( &self, ) -> Option<&SseAwsKeyManagementParams>
An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.
Sourcepub fn sink_iam_role_arn(&self) -> Option<&str>
pub fn sink_iam_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId
in SseAwsKeyManagementParams
.
Source§impl MediaCapturePipeline
impl MediaCapturePipeline
Sourcepub fn builder() -> MediaCapturePipelineBuilder
pub fn builder() -> MediaCapturePipelineBuilder
Creates a new builder-style object to manufacture MediaCapturePipeline
.
Trait Implementations§
Source§impl Clone for MediaCapturePipeline
impl Clone for MediaCapturePipeline
Source§fn clone(&self) -> MediaCapturePipeline
fn clone(&self) -> MediaCapturePipeline
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MediaCapturePipeline
impl Debug for MediaCapturePipeline
Source§impl PartialEq for MediaCapturePipeline
impl PartialEq for MediaCapturePipeline
impl StructuralPartialEq for MediaCapturePipeline
Auto Trait Implementations§
impl Freeze for MediaCapturePipeline
impl RefUnwindSafe for MediaCapturePipeline
impl Send for MediaCapturePipeline
impl Sync for MediaCapturePipeline
impl Unpin for MediaCapturePipeline
impl UnwindSafe for MediaCapturePipeline
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);