Skip to content

Latest commit

 

History

History
264 lines (236 loc) · 17.2 KB

audio.md

File metadata and controls

264 lines (236 loc) · 17.2 KB
Raw

Audio

audio_controller = client.audio

Class Name

AudioController

Methods

Get Audio Stream

Gets an audio stream.

def get_audio_stream(self,
                    item_id,
                    container=None,
                    static=None,
                    params=None,
                    tag=None,
                    device_profile_id=None,
                    play_session_id=None,
                    segment_container=None,
                    segment_length=None,
                    min_segments=None,
                    media_source_id=None,
                    device_id=None,
                    audio_codec=None,
                    enable_auto_stream_copy=None,
                    allow_video_stream_copy=None,
                    allow_audio_stream_copy=None,
                    break_on_non_key_frames=None,
                    audio_sample_rate=None,
                    max_audio_bit_depth=None,
                    audio_bit_rate=None,
                    audio_channels=None,
                    max_audio_channels=None,
                    profile=None,
                    level=None,
                    framerate=None,
                    max_framerate=None,
                    copy_timestamps=None,
                    start_time_ticks=None,
                    width=None,
                    height=None,
                    video_bit_rate=None,
                    subtitle_stream_index=None,
                    subtitle_method=None,
                    max_ref_frames=None,
                    max_video_bit_depth=None,
                    require_avc=None,
                    de_interlace=None,
                    require_non_anamorphic=None,
                    transcoding_max_audio_channels=None,
                    cpu_core_limit=None,
                    live_stream_id=None,
                    enable_mpegts_m_2_ts_mode=None,
                    video_codec=None,
                    subtitle_codec=None,
                    transcode_reasons=None,
                    audio_stream_index=None,
                    video_stream_index=None,
                    context=None,
                    stream_options=None)

Parameters

Parameter Type Tags Description
item_id uuid|string Template, Required The item id.
container string Query, Optional The audio container.
static bool Query, Optional Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
params string Query, Optional The streaming parameters.
tag string Query, Optional The tag.
device_profile_id string Query, Optional Optional. The dlna device profile id to utilize.
play_session_id string Query, Optional The play session id.
segment_container string Query, Optional The segment container.
segment_length int Query, Optional The segment length.
min_segments int Query, Optional The minimum number of segments.
media_source_id string Query, Optional The media version id, if playing an alternate version.
device_id string Query, Optional The device id of the client requesting. Used to stop encoding processes when needed.
audio_codec string Query, Optional Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.
enable_auto_stream_copy bool Query, Optional Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
allow_video_stream_copy bool Query, Optional Whether or not to allow copying of the video stream url.
allow_audio_stream_copy bool Query, Optional Whether or not to allow copying of the audio stream url.
break_on_non_key_frames bool Query, Optional Optional. Whether to break on non key frames.
audio_sample_rate int Query, Optional Optional. Specify a specific audio sample rate, e.g. 44100.
max_audio_bit_depth int Query, Optional Optional. The maximum audio bit depth.
audio_bit_rate int Query, Optional Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
audio_channels int Query, Optional Optional. Specify a specific number of audio channels to encode to, e.g. 2.
max_audio_channels int Query, Optional Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
profile string Query, Optional Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
level string Query, Optional Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
framerate float Query, Optional Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
max_framerate float Query, Optional Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
copy_timestamps bool Query, Optional Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
start_time_ticks long|int Query, Optional Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
width int Query, Optional Optional. The fixed horizontal resolution of the encoded video.
height int Query, Optional Optional. The fixed vertical resolution of the encoded video.
video_bit_rate int Query, Optional Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
subtitle_stream_index int Query, Optional Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
subtitle_method SubtitleDeliveryMethodEnum Query, Optional Optional. Specify the subtitle delivery method.
max_ref_frames int Query, Optional Optional.
max_video_bit_depth int Query, Optional Optional. The maximum video bit depth.
require_avc bool Query, Optional Optional. Whether to require avc.
de_interlace bool Query, Optional Optional. Whether to deinterlace the video.
require_non_anamorphic bool Query, Optional Optional. Whether to require a non anamorphic stream.
transcoding_max_audio_channels int Query, Optional Optional. The maximum number of audio channels to transcode.
cpu_core_limit int Query, Optional Optional. The limit of how many cpu cores to use.
live_stream_id string Query, Optional The live stream id.
enable_mpegts_m_2_ts_mode bool Query, Optional Optional. Whether to enable the MpegtsM2Ts mode.
video_codec string Query, Optional Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv.
subtitle_codec string Query, Optional Optional. Specify a subtitle codec to encode to.
transcode_reasons string Query, Optional Optional. The transcoding reason.
audio_stream_index int Query, Optional Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
video_stream_index int Query, Optional Optional. The index of the video stream to use. If omitted the first video stream will be used.
context EncodingContextEnum Query, Optional Optional. The MediaBrowser.Model.Dlna.EncodingContext.
stream_options dict Query, Optional Optional. The streaming options.

Response Type

mixed

Example Usage

item_id = '0000130e-0000-0000-0000-000000000000'

result = audio_controller.get_audio_stream(item_id)

Get Audio Stream by Container

Gets an audio stream.

def get_audio_stream_by_container(self,
                                 item_id,
                                 container,
                                 static=None,
                                 params=None,
                                 tag=None,
                                 device_profile_id=None,
                                 play_session_id=None,
                                 segment_container=None,
                                 segment_length=None,
                                 min_segments=None,
                                 media_source_id=None,
                                 device_id=None,
                                 audio_codec=None,
                                 enable_auto_stream_copy=None,
                                 allow_video_stream_copy=None,
                                 allow_audio_stream_copy=None,
                                 break_on_non_key_frames=None,
                                 audio_sample_rate=None,
                                 max_audio_bit_depth=None,
                                 audio_bit_rate=None,
                                 audio_channels=None,
                                 max_audio_channels=None,
                                 profile=None,
                                 level=None,
                                 framerate=None,
                                 max_framerate=None,
                                 copy_timestamps=None,
                                 start_time_ticks=None,
                                 width=None,
                                 height=None,
                                 video_bit_rate=None,
                                 subtitle_stream_index=None,
                                 subtitle_method=None,
                                 max_ref_frames=None,
                                 max_video_bit_depth=None,
                                 require_avc=None,
                                 de_interlace=None,
                                 require_non_anamorphic=None,
                                 transcoding_max_audio_channels=None,
                                 cpu_core_limit=None,
                                 live_stream_id=None,
                                 enable_mpegts_m_2_ts_mode=None,
                                 video_codec=None,
                                 subtitle_codec=None,
                                 transcode_reasons=None,
                                 audio_stream_index=None,
                                 video_stream_index=None,
                                 context=None,
                                 stream_options=None)

Parameters

Parameter Type Tags Description
item_id uuid|string Template, Required The item id.
container string Template, Required The audio container.
static bool Query, Optional Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
params string Query, Optional The streaming parameters.
tag string Query, Optional The tag.
device_profile_id string Query, Optional Optional. The dlna device profile id to utilize.
play_session_id string Query, Optional The play session id.
segment_container string Query, Optional The segment container.
segment_length int Query, Optional The segment lenght.
min_segments int Query, Optional The minimum number of segments.
media_source_id string Query, Optional The media version id, if playing an alternate version.
device_id string Query, Optional The device id of the client requesting. Used to stop encoding processes when needed.
audio_codec string Query, Optional Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.
enable_auto_stream_copy bool Query, Optional Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
allow_video_stream_copy bool Query, Optional Whether or not to allow copying of the video stream url.
allow_audio_stream_copy bool Query, Optional Whether or not to allow copying of the audio stream url.
break_on_non_key_frames bool Query, Optional Optional. Whether to break on non key frames.
audio_sample_rate int Query, Optional Optional. Specify a specific audio sample rate, e.g. 44100.
max_audio_bit_depth int Query, Optional Optional. The maximum audio bit depth.
audio_bit_rate int Query, Optional Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
audio_channels int Query, Optional Optional. Specify a specific number of audio channels to encode to, e.g. 2.
max_audio_channels int Query, Optional Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
profile string Query, Optional Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
level string Query, Optional Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
framerate float Query, Optional Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
max_framerate float Query, Optional Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
copy_timestamps bool Query, Optional Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
start_time_ticks long|int Query, Optional Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
width int Query, Optional Optional. The fixed horizontal resolution of the encoded video.
height int Query, Optional Optional. The fixed vertical resolution of the encoded video.
video_bit_rate int Query, Optional Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
subtitle_stream_index int Query, Optional Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
subtitle_method SubtitleDeliveryMethodEnum Query, Optional Optional. Specify the subtitle delivery method.
max_ref_frames int Query, Optional Optional.
max_video_bit_depth int Query, Optional Optional. The maximum video bit depth.
require_avc bool Query, Optional Optional. Whether to require avc.
de_interlace bool Query, Optional Optional. Whether to deinterlace the video.
require_non_anamorphic bool Query, Optional Optional. Whether to require a non anamporphic stream.
transcoding_max_audio_channels int Query, Optional Optional. The maximum number of audio channels to transcode.
cpu_core_limit int Query, Optional Optional. The limit of how many cpu cores to use.
live_stream_id string Query, Optional The live stream id.
enable_mpegts_m_2_ts_mode bool Query, Optional Optional. Whether to enable the MpegtsM2Ts mode.
video_codec string Query, Optional Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv.
subtitle_codec string Query, Optional Optional. Specify a subtitle codec to encode to.
transcode_reasons string Query, Optional Optional. The transcoding reason.
audio_stream_index int Query, Optional Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
video_stream_index int Query, Optional Optional. The index of the video stream to use. If omitted the first video stream will be used.
context EncodingContextEnum Query, Optional Optional. The MediaBrowser.Model.Dlna.EncodingContext.
stream_options dict Query, Optional Optional. The streaming options.

Response Type

mixed

Example Usage

item_id = '0000130e-0000-0000-0000-000000000000'
container = 'container2'

result = audio_controller.get_audio_stream_by_container(item_id, container)