#[non_exhaustive]pub struct Output {Show 17 fields
pub data_transfer_subscriber_fee_percent: Option<i32>,
pub description: Option<String>,
pub destination: Option<String>,
pub encryption: Option<Encryption>,
pub entitlement_arn: Option<String>,
pub listener_address: Option<String>,
pub media_live_input_arn: Option<String>,
pub media_stream_output_configurations: Option<Vec<MediaStreamOutputConfiguration>>,
pub name: Option<String>,
pub output_arn: Option<String>,
pub port: Option<i32>,
pub transport: Option<Transport>,
pub vpc_interface_attachment: Option<VpcInterfaceAttachment>,
pub bridge_arn: Option<String>,
pub bridge_ports: Option<Vec<i32>>,
pub output_status: Option<OutputStatus>,
pub peer_ip_address: Option<String>,
}
Expand description
The settings for an output.
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.data_transfer_subscriber_fee_percent: Option<i32>
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
description: Option<String>
A description of the output.
destination: Option<String>
The address where you want to send the output.
encryption: Option<Encryption>
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
entitlement_arn: Option<String>
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
listener_address: Option<String>
The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
media_live_input_arn: Option<String>
The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
media_stream_output_configurations: Option<Vec<MediaStreamOutputConfiguration>>
The configuration for each media stream that is associated with the output.
name: Option<String>
The name of the output. This value must be unique within the current flow.
output_arn: Option<String>
The ARN of the output.
port: Option<i32>
The port to use when content is distributed to this output.
transport: Option<Transport>
Attributes related to the transport stream that are used in the output.
vpc_interface_attachment: Option<VpcInterfaceAttachment>
The name of the VPC interface attachment to use for this output.
bridge_arn: Option<String>
The ARN of the bridge added to this output.
bridge_ports: Option<Vec<i32>>
The bridge output ports currently in use.
output_status: Option<OutputStatus>
An indication of whether the output is transmitting data or not.
peer_ip_address: Option<String>
The IP address of the device that is currently receiving content from this output.
-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
Implementations§
Source§impl Output
impl Output
Sourcepub fn data_transfer_subscriber_fee_percent(&self) -> Option<i32>
pub fn data_transfer_subscriber_fee_percent(&self) -> Option<i32>
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the output.
Sourcepub fn destination(&self) -> Option<&str>
pub fn destination(&self) -> Option<&str>
The address where you want to send the output.
Sourcepub fn encryption(&self) -> Option<&Encryption>
pub fn encryption(&self) -> Option<&Encryption>
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Sourcepub fn entitlement_arn(&self) -> Option<&str>
pub fn entitlement_arn(&self) -> Option<&str>
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
Sourcepub fn listener_address(&self) -> Option<&str>
pub fn listener_address(&self) -> Option<&str>
The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
Sourcepub fn media_live_input_arn(&self) -> Option<&str>
pub fn media_live_input_arn(&self) -> Option<&str>
The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
Sourcepub fn media_stream_output_configurations(
&self,
) -> &[MediaStreamOutputConfiguration]
pub fn media_stream_output_configurations( &self, ) -> &[MediaStreamOutputConfiguration]
The configuration for each media stream that is associated with the output.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .media_stream_output_configurations.is_none()
.
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
The name of the output. This value must be unique within the current flow.
Sourcepub fn output_arn(&self) -> Option<&str>
pub fn output_arn(&self) -> Option<&str>
The ARN of the output.
Sourcepub fn transport(&self) -> Option<&Transport>
pub fn transport(&self) -> Option<&Transport>
Attributes related to the transport stream that are used in the output.
Sourcepub fn vpc_interface_attachment(&self) -> Option<&VpcInterfaceAttachment>
pub fn vpc_interface_attachment(&self) -> Option<&VpcInterfaceAttachment>
The name of the VPC interface attachment to use for this output.
Sourcepub fn bridge_arn(&self) -> Option<&str>
pub fn bridge_arn(&self) -> Option<&str>
The ARN of the bridge added to this output.
Sourcepub fn bridge_ports(&self) -> &[i32]
pub fn bridge_ports(&self) -> &[i32]
The bridge output ports currently in use.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bridge_ports.is_none()
.
Sourcepub fn output_status(&self) -> Option<&OutputStatus>
pub fn output_status(&self) -> Option<&OutputStatus>
An indication of whether the output is transmitting data or not.
Sourcepub fn peer_ip_address(&self) -> Option<&str>
pub fn peer_ip_address(&self) -> Option<&str>
The IP address of the device that is currently receiving content from this output.
-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
Trait Implementations§
impl StructuralPartialEq for Output
Auto Trait Implementations§
impl Freeze for Output
impl RefUnwindSafe for Output
impl Send for Output
impl Sync for Output
impl Unpin for Output
impl UnwindSafe for Output
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);