#[non_exhaustive]pub struct GetPlaybackConfigurationOutput {Show 21 fields
pub ad_decision_server_url: Option<String>,
pub avail_suppression: Option<AvailSuppression>,
pub bumper: Option<Bumper>,
pub cdn_configuration: Option<CdnConfiguration>,
pub configuration_aliases: Option<HashMap<String, HashMap<String, String>>>,
pub dash_configuration: Option<DashConfiguration>,
pub hls_configuration: Option<HlsConfiguration>,
pub insertion_mode: InsertionMode,
pub live_pre_roll_configuration: Option<LivePreRollConfiguration>,
pub log_configuration: Option<LogConfiguration>,
pub manifest_processing_rules: Option<ManifestProcessingRules>,
pub name: Option<String>,
pub personalization_threshold_seconds: Option<i32>,
pub playback_configuration_arn: Option<String>,
pub playback_endpoint_prefix: Option<String>,
pub session_initialization_endpoint_prefix: Option<String>,
pub slate_ad_url: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub transcode_profile_name: Option<String>,
pub video_content_source_url: Option<String>,
pub ad_conditioning_configuration: Option<AdConditioningConfiguration>,
/* private fields */
}
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.ad_decision_server_url: Option<String>
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
avail_suppression: Option<AvailSuppression>
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
bumper: Option<Bumper>
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
cdn_configuration: Option<CdnConfiguration>
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configuration_aliases: Option<HashMap<String, HashMap<String, String>>>
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
dash_configuration: Option<DashConfiguration>
The configuration for DASH content.
hls_configuration: Option<HlsConfiguration>
The configuration for HLS content.
insertion_mode: InsertionMode
The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY
, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT
allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
live_pre_roll_configuration: Option<LivePreRollConfiguration>
The configuration for pre-roll ad insertion.
log_configuration: Option<LogConfiguration>
The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
manifest_processing_rules: Option<ManifestProcessingRules>
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
name: Option<String>
The identifier for the playback configuration.
personalization_threshold_seconds: Option<i32>
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
playback_configuration_arn: Option<String>
The Amazon Resource Name (ARN) for the playback configuration.
playback_endpoint_prefix: Option<String>
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
session_initialization_endpoint_prefix: Option<String>
The URL that the player uses to initialize a session that uses client-side reporting.
slate_ad_url: Option<String>
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
transcode_profile_name: Option<String>
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
video_content_source_url: Option<String>
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
ad_conditioning_configuration: Option<AdConditioningConfiguration>
The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
Implementations§
Source§impl GetPlaybackConfigurationOutput
impl GetPlaybackConfigurationOutput
Sourcepub fn ad_decision_server_url(&self) -> Option<&str>
pub fn ad_decision_server_url(&self) -> Option<&str>
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
Sourcepub fn avail_suppression(&self) -> Option<&AvailSuppression>
pub fn avail_suppression(&self) -> Option<&AvailSuppression>
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Sourcepub fn bumper(&self) -> Option<&Bumper>
pub fn bumper(&self) -> Option<&Bumper>
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
Sourcepub fn cdn_configuration(&self) -> Option<&CdnConfiguration>
pub fn cdn_configuration(&self) -> Option<&CdnConfiguration>
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Sourcepub fn configuration_aliases(
&self,
) -> Option<&HashMap<String, HashMap<String, String>>>
pub fn configuration_aliases( &self, ) -> Option<&HashMap<String, HashMap<String, String>>>
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
Sourcepub fn dash_configuration(&self) -> Option<&DashConfiguration>
pub fn dash_configuration(&self) -> Option<&DashConfiguration>
The configuration for DASH content.
Sourcepub fn hls_configuration(&self) -> Option<&HlsConfiguration>
pub fn hls_configuration(&self) -> Option<&HlsConfiguration>
The configuration for HLS content.
Sourcepub fn insertion_mode(&self) -> &InsertionMode
pub fn insertion_mode(&self) -> &InsertionMode
The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY
, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT
allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
Sourcepub fn live_pre_roll_configuration(&self) -> Option<&LivePreRollConfiguration>
pub fn live_pre_roll_configuration(&self) -> Option<&LivePreRollConfiguration>
The configuration for pre-roll ad insertion.
Sourcepub fn log_configuration(&self) -> Option<&LogConfiguration>
pub fn log_configuration(&self) -> Option<&LogConfiguration>
The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
Sourcepub fn manifest_processing_rules(&self) -> Option<&ManifestProcessingRules>
pub fn manifest_processing_rules(&self) -> Option<&ManifestProcessingRules>
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
Sourcepub fn personalization_threshold_seconds(&self) -> Option<i32>
pub fn personalization_threshold_seconds(&self) -> Option<i32>
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
Sourcepub fn playback_configuration_arn(&self) -> Option<&str>
pub fn playback_configuration_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the playback configuration.
Sourcepub fn playback_endpoint_prefix(&self) -> Option<&str>
pub fn playback_endpoint_prefix(&self) -> Option<&str>
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
Sourcepub fn session_initialization_endpoint_prefix(&self) -> Option<&str>
pub fn session_initialization_endpoint_prefix(&self) -> Option<&str>
The URL that the player uses to initialize a session that uses client-side reporting.
Sourcepub fn slate_ad_url(&self) -> Option<&str>
pub fn slate_ad_url(&self) -> Option<&str>
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
Sourcepub fn transcode_profile_name(&self) -> Option<&str>
pub fn transcode_profile_name(&self) -> Option<&str>
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
Sourcepub fn video_content_source_url(&self) -> Option<&str>
pub fn video_content_source_url(&self) -> Option<&str>
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
Sourcepub fn ad_conditioning_configuration(
&self,
) -> Option<&AdConditioningConfiguration>
pub fn ad_conditioning_configuration( &self, ) -> Option<&AdConditioningConfiguration>
The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
Source§impl GetPlaybackConfigurationOutput
impl GetPlaybackConfigurationOutput
Sourcepub fn builder() -> GetPlaybackConfigurationOutputBuilder
pub fn builder() -> GetPlaybackConfigurationOutputBuilder
Creates a new builder-style object to manufacture GetPlaybackConfigurationOutput
.
Trait Implementations§
Source§impl Clone for GetPlaybackConfigurationOutput
impl Clone for GetPlaybackConfigurationOutput
Source§fn clone(&self) -> GetPlaybackConfigurationOutput
fn clone(&self) -> GetPlaybackConfigurationOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for GetPlaybackConfigurationOutput
impl PartialEq for GetPlaybackConfigurationOutput
Source§fn eq(&self, other: &GetPlaybackConfigurationOutput) -> bool
fn eq(&self, other: &GetPlaybackConfigurationOutput) -> bool
self
and other
values to be equal, and is used by ==
.Source§impl RequestId for GetPlaybackConfigurationOutput
impl RequestId for GetPlaybackConfigurationOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for GetPlaybackConfigurationOutput
Auto Trait Implementations§
impl Freeze for GetPlaybackConfigurationOutput
impl RefUnwindSafe for GetPlaybackConfigurationOutput
impl Send for GetPlaybackConfigurationOutput
impl Sync for GetPlaybackConfigurationOutput
impl Unpin for GetPlaybackConfigurationOutput
impl UnwindSafe for GetPlaybackConfigurationOutput
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);