@aws-cdk/aws-medialive-alpha.AudioSelector

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AudioSelector Class

An audio selector that identifies which audio to extract from the input.

Stability

Experimental

Source

lib/audio-selector.ts

Example

declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;

new medialive.Channel(stack, 'Channel', {
  inputs: [{
    input,
    audioSelectors: [
      medialive.AudioSelector.byLanguage('eng', 'eng', medialive.AudioLanguageSelectionPolicy.STRICT),
    ],
    captionSelectors: [
      medialive.CaptionSelector.embedded('embedded'),
    ],
    videoSelector: {
      colorSpace: medialive.VideoColorSpace.HDR10,
      colorSpaceUsage: medialive.VideoColorSpaceUsage.FORCE,
      selectBy: medialive.VideoSelection.byProgramId(1),
    },
  }],
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video], outputName: 'hls_out' }],
    }),
  ],
});

Properties

namestringnamestrnameStringNamestringName*stringrequired#

The name of this audio selector.

Reference it from features that monitor a specific selector, such as an audio-silence {@link FailoverCondition }.

Methods

byLanguage(name: string, languageCode: string, languageSelectionPolicy?: AudioLanguageSelectionPolicy): AudioSelector // chainable@staticmethod def by_language(name: str, language_code: str, language_selection_policy: typing.Optional[AudioLanguageSelectionPolicy] = None) -> AudioSelectorpublic static AudioSelector byLanguage(String name, String languageCode, AudioLanguageSelectionPolicy languageSelectionPolicy)public static AudioSelector ByLanguage(string name, string languageCode, AudioLanguageSelectionPolicy? languageSelectionPolicy = null)func ByLanguage(Name *string, LanguageCode *string, LanguageSelectionPolicy AudioLanguageSelectionPolicy) AudioSelectorstatic#

Select audio by language code.

3 parameters

Parameters

• namenamenamenameName — a name for this selector.
• languageCodelanguage_codelanguageCodelanguageCodeLanguageCode — the three-letter (ISO 639-2) language code to select.
• languageSelectionPolicylanguage_selection_policylanguageSelectionPolicylanguageSelectionPolicyLanguageSelectionPolicy — how strictly to identify the stream by language on a PMT update.

byPid(name: string, pids: AudioPidConfig[]): AudioSelector // chainable@staticmethod def by_pid(name: str, pids: typing.List[AudioPidConfig]) -> AudioSelectorpublic static AudioSelector byPid(String name, List<AudioPidConfig> pids)public static AudioSelector ByPid(string name, AudioPidConfig[] pids)func ByPid(Name *string, Pids *[]AudioPidConfig) AudioSelectorstatic#

Select one or more audio PIDs from the source.

2 parameters

Parameters

• namenamenamenameName — a name for this selector.
• pidspidspidspidsPids — the PID configurations (each with optional Dolby E decode and pre-mix settings).

byTrack(name: string, tracks: AudioTrackConfig[], dolbyEProgramSelection?: DolbyEProgramSelection): AudioSelector // chainable@staticmethod def by_track(name: str, tracks: typing.List[AudioTrackConfig], dolby_e_program_selection: typing.Optional[DolbyEProgramSelection] = None) -> AudioSelectorpublic static AudioSelector byTrack(String name, List<AudioTrackConfig> tracks, DolbyEProgramSelection dolbyEProgramSelection)public static AudioSelector ByTrack(string name, AudioTrackConfig[] tracks, DolbyEProgramSelection? dolbyEProgramSelection = null)func ByTrack(Name *string, Tracks *[]AudioTrackConfig, DolbyEProgramSelection DolbyEProgramSelection) AudioSelectorstatic#

Select one or more audio tracks (1-based) from the source.

3 parameters

Parameters

• namenamenamenameName — a name for this selector.
• trackstrackstrackstracksTracks — the track configurations (each with optional pre-mix settings).
• dolbyEProgramSelectiondolby_e_program_selectiondolbyEProgramSelectiondolbyEProgramSelectionDolbyEProgramSelection — which Dolby E program to decode from the selected track(s).

default(name: string): AudioSelector // chainable@staticmethod def default(name: str) -> AudioSelectorpublic static AudioSelector default(String name)public static AudioSelector Default(string name)func Default(Name *string) AudioSelectorstatic#

Select the default audio track (no specific selector settings).

hlsRendition(name: string, options: HlsRenditionSelectionOptions): AudioSelector // chainable@staticmethod def hls_rendition(name: str, options: HlsRenditionSelectionOptions) -> AudioSelectorpublic static AudioSelector hlsRendition(String name, HlsRenditionSelectionOptions options)public static AudioSelector HlsRendition(string name, HlsRenditionSelectionOptions options)func HlsRendition(Name *string, Options HlsRenditionSelectionOptions) AudioSelectorstatic#

Select an HLS audio rendition by its `#EXT-X-MEDIA` `GROUP-ID` and `NAME`.

2 parameters

Parameters

• namenamenamenameName — a name for this selector.
• optionsoptionsoptionsoptionsOptions — the target rendition's group id and name.