#[non_exhaustive]pub struct AudioParametersBuilder { /* private fields */ }
Expand description
A builder for AudioParameters
.
Implementations§
source§impl AudioParametersBuilder
impl AudioParametersBuilder
sourcepub fn codec(self, input: impl Into<String>) -> Self
pub fn codec(self, input: impl Into<String>) -> Self
The audio codec for the output file. Valid values include aac
, flac
, mp2
, mp3
, pcm
, and vorbis
.
sourcepub fn set_codec(self, input: Option<String>) -> Self
pub fn set_codec(self, input: Option<String>) -> Self
The audio codec for the output file. Valid values include aac
, flac
, mp2
, mp3
, pcm
, and vorbis
.
sourcepub fn get_codec(&self) -> &Option<String>
pub fn get_codec(&self) -> &Option<String>
The audio codec for the output file. Valid values include aac
, flac
, mp2
, mp3
, pcm
, and vorbis
.
sourcepub fn sample_rate(self, input: impl Into<String>) -> Self
pub fn sample_rate(self, input: impl Into<String>) -> Self
The sample rate of the audio stream in the output file, in Hertz. Valid values include:
auto
, 22050
, 32000
, 44100
, 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
sourcepub fn set_sample_rate(self, input: Option<String>) -> Self
pub fn set_sample_rate(self, input: Option<String>) -> Self
The sample rate of the audio stream in the output file, in Hertz. Valid values include:
auto
, 22050
, 32000
, 44100
, 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
sourcepub fn get_sample_rate(&self) -> &Option<String>
pub fn get_sample_rate(&self) -> &Option<String>
The sample rate of the audio stream in the output file, in Hertz. Valid values include:
auto
, 22050
, 32000
, 44100
, 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
sourcepub fn bit_rate(self, input: impl Into<String>) -> Self
pub fn bit_rate(self, input: impl Into<String>) -> Self
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.
sourcepub fn set_bit_rate(self, input: Option<String>) -> Self
pub fn set_bit_rate(self, input: Option<String>) -> Self
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.
sourcepub fn get_bit_rate(&self) -> &Option<String>
pub fn get_bit_rate(&self) -> &Option<String>
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.
sourcepub fn channels(self, input: impl Into<String>) -> Self
pub fn channels(self, input: impl Into<String>) -> Self
The number of audio channels in the output file. The following values are valid:
auto
, 0
, 1
, 2
One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto
.
The output of a specific channel value and inputs are as follows:
-
auto
channel specified, with any input: Pass through up to eight input channels. -
0
channels specified, with any input: Audio omitted from the output. -
1
channel specified, with at least one input channel: Mono sound. -
2
channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, seeAudio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode
.
sourcepub fn set_channels(self, input: Option<String>) -> Self
pub fn set_channels(self, input: Option<String>) -> Self
The number of audio channels in the output file. The following values are valid:
auto
, 0
, 1
, 2
One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto
.
The output of a specific channel value and inputs are as follows:
-
auto
channel specified, with any input: Pass through up to eight input channels. -
0
channels specified, with any input: Audio omitted from the output. -
1
channel specified, with at least one input channel: Mono sound. -
2
channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, seeAudio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode
.
sourcepub fn get_channels(&self) -> &Option<String>
pub fn get_channels(&self) -> &Option<String>
The number of audio channels in the output file. The following values are valid:
auto
, 0
, 1
, 2
One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto
.
The output of a specific channel value and inputs are as follows:
-
auto
channel specified, with any input: Pass through up to eight input channels. -
0
channels specified, with any input: Audio omitted from the output. -
1
channel specified, with at least one input channel: Mono sound. -
2
channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, seeAudio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode
.
sourcepub fn audio_packing_mode(self, input: impl Into<String>) -> Self
pub fn audio_packing_mode(self, input: impl Into<String>) -> Self
The method of organizing audio channels and tracks. Use Audio:Channels
to specify the number of channels in your output, and Audio:AudioPackingMode
to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode
, Elastic Transcoder uses SingleTrack
.
The following values are valid:
SingleTrack
, OneChannelPerTrack
, and OneChannelPerTrackWithMosTo8Tracks
When you specify SingleTrack
, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack
for all non-mxf
containers.
The outputs of SingleTrack
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary -
2
channels with one track with one channel: One track with two identical channels -
2 or auto
channels with two tracks with one channel each: One track with two channels -
2 or auto
channels with one track with two channels: One track with two channels -
2
channels with one track with multiple channels: One track with two channels -
auto
channels with one track with one channel: One track with one channel -
auto
channels with one track with multiple channels: One track with multiple channels
When you specify OneChannelPerTrack
, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.
The outputs of OneChannelPerTrack
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary -
2
channels with one track with one channel: Two tracks with one identical channel each -
2 or auto
channels with two tracks with one channel each: Two tracks with one channel each -
2 or auto
channels with one track with two channels: Two tracks with one channel each -
2
channels with one track with multiple channels: Two tracks with one channel each -
auto
channels with one track with one channel: One track with one channel -
auto
channels with one track with multiple channels: Up to eight tracks with one channel each
When you specify OneChannelPerTrackWithMosTo8Tracks
, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.
The outputs of OneChannelPerTrackWithMosTo8Tracks
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks -
2
channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks -
2 or auto
channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks -
2 or auto
channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks -
2
channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks -
auto
channels with one track with one channel: One track with one channel, plus seven MOS tracks -
auto
channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all
sourcepub fn set_audio_packing_mode(self, input: Option<String>) -> Self
pub fn set_audio_packing_mode(self, input: Option<String>) -> Self
The method of organizing audio channels and tracks. Use Audio:Channels
to specify the number of channels in your output, and Audio:AudioPackingMode
to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode
, Elastic Transcoder uses SingleTrack
.
The following values are valid:
SingleTrack
, OneChannelPerTrack
, and OneChannelPerTrackWithMosTo8Tracks
When you specify SingleTrack
, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack
for all non-mxf
containers.
The outputs of SingleTrack
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary -
2
channels with one track with one channel: One track with two identical channels -
2 or auto
channels with two tracks with one channel each: One track with two channels -
2 or auto
channels with one track with two channels: One track with two channels -
2
channels with one track with multiple channels: One track with two channels -
auto
channels with one track with one channel: One track with one channel -
auto
channels with one track with multiple channels: One track with multiple channels
When you specify OneChannelPerTrack
, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.
The outputs of OneChannelPerTrack
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary -
2
channels with one track with one channel: Two tracks with one identical channel each -
2 or auto
channels with two tracks with one channel each: Two tracks with one channel each -
2 or auto
channels with one track with two channels: Two tracks with one channel each -
2
channels with one track with multiple channels: Two tracks with one channel each -
auto
channels with one track with one channel: One track with one channel -
auto
channels with one track with multiple channels: Up to eight tracks with one channel each
When you specify OneChannelPerTrackWithMosTo8Tracks
, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.
The outputs of OneChannelPerTrackWithMosTo8Tracks
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks -
2
channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks -
2 or auto
channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks -
2 or auto
channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks -
2
channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks -
auto
channels with one track with one channel: One track with one channel, plus seven MOS tracks -
auto
channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all
sourcepub fn get_audio_packing_mode(&self) -> &Option<String>
pub fn get_audio_packing_mode(&self) -> &Option<String>
The method of organizing audio channels and tracks. Use Audio:Channels
to specify the number of channels in your output, and Audio:AudioPackingMode
to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode
, Elastic Transcoder uses SingleTrack
.
The following values are valid:
SingleTrack
, OneChannelPerTrack
, and OneChannelPerTrackWithMosTo8Tracks
When you specify SingleTrack
, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack
for all non-mxf
containers.
The outputs of SingleTrack
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary -
2
channels with one track with one channel: One track with two identical channels -
2 or auto
channels with two tracks with one channel each: One track with two channels -
2 or auto
channels with one track with two channels: One track with two channels -
2
channels with one track with multiple channels: One track with two channels -
auto
channels with one track with one channel: One track with one channel -
auto
channels with one track with multiple channels: One track with multiple channels
When you specify OneChannelPerTrack
, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.
The outputs of OneChannelPerTrack
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary -
2
channels with one track with one channel: Two tracks with one identical channel each -
2 or auto
channels with two tracks with one channel each: Two tracks with one channel each -
2 or auto
channels with one track with two channels: Two tracks with one channel each -
2
channels with one track with multiple channels: Two tracks with one channel each -
auto
channels with one track with one channel: One track with one channel -
auto
channels with one track with multiple channels: Up to eight tracks with one channel each
When you specify OneChannelPerTrackWithMosTo8Tracks
, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.
The outputs of OneChannelPerTrackWithMosTo8Tracks
for a specific channel value and inputs are as follows:
-
0
channels with any input: Audio omitted from the output -
1, 2, or auto
channels with no audio input: Audio omitted from the output -
1
channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks -
2
channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks -
2 or auto
channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks -
2 or auto
channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks -
2
channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks -
auto
channels with one track with one channel: One track with one channel, plus seven MOS tracks -
auto
channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all
sourcepub fn codec_options(self, input: AudioCodecOptions) -> Self
pub fn codec_options(self, input: AudioCodecOptions) -> Self
If you specified AAC
for Audio:Codec
, this is the AAC
compression profile to use. Valid values include:
auto
, AAC-LC
, HE-AAC
, HE-AACv2
If you specify auto
, Elastic Transcoder chooses a profile based on the bit rate of the output file.
sourcepub fn set_codec_options(self, input: Option<AudioCodecOptions>) -> Self
pub fn set_codec_options(self, input: Option<AudioCodecOptions>) -> Self
If you specified AAC
for Audio:Codec
, this is the AAC
compression profile to use. Valid values include:
auto
, AAC-LC
, HE-AAC
, HE-AACv2
If you specify auto
, Elastic Transcoder chooses a profile based on the bit rate of the output file.
sourcepub fn get_codec_options(&self) -> &Option<AudioCodecOptions>
pub fn get_codec_options(&self) -> &Option<AudioCodecOptions>
If you specified AAC
for Audio:Codec
, this is the AAC
compression profile to use. Valid values include:
auto
, AAC-LC
, HE-AAC
, HE-AACv2
If you specify auto
, Elastic Transcoder chooses a profile based on the bit rate of the output file.
sourcepub fn build(self) -> AudioParameters
pub fn build(self) -> AudioParameters
Consumes the builder and constructs a AudioParameters
.
Trait Implementations§
source§impl Clone for AudioParametersBuilder
impl Clone for AudioParametersBuilder
source§fn clone(&self) -> AudioParametersBuilder
fn clone(&self) -> AudioParametersBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AudioParametersBuilder
impl Debug for AudioParametersBuilder
source§impl Default for AudioParametersBuilder
impl Default for AudioParametersBuilder
source§fn default() -> AudioParametersBuilder
fn default() -> AudioParametersBuilder
source§impl PartialEq for AudioParametersBuilder
impl PartialEq for AudioParametersBuilder
source§fn eq(&self, other: &AudioParametersBuilder) -> bool
fn eq(&self, other: &AudioParametersBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AudioParametersBuilder
Auto Trait Implementations§
impl Freeze for AudioParametersBuilder
impl RefUnwindSafe for AudioParametersBuilder
impl Send for AudioParametersBuilder
impl Sync for AudioParametersBuilder
impl Unpin for AudioParametersBuilder
impl UnwindSafe for AudioParametersBuilder
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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