Interface IMediaSourceManager

Namespace: MediaBrowser.Controller.Library

Assembly: MediaBrowser.Controller.dll

Syntax

public interface IMediaSourceManager

Methods

AddMediaInfoWithProbe(MediaSourceInfo, Boolean, Boolean, CancellationToken)

Declaration

Task AddMediaInfoWithProbe(MediaSourceInfo mediaSource, bool isAudio, bool addProbeDelay, CancellationToken cancellationToken)

Parameters

Type	Name	Description
MediaSourceInfo	mediaSource
System.Boolean	isAudio
System.Boolean	addProbeDelay
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

AddMediaInfoWithProbeSafe(MediaSourceInfo, Boolean, Boolean, CancellationToken)

Declaration

Task AddMediaInfoWithProbeSafe(MediaSourceInfo mediaSource, bool isAudio, bool addProbeDelay, CancellationToken cancellationToken)

Parameters

Type	Name	Description
MediaSourceInfo	mediaSource
System.Boolean	isAudio
System.Boolean	addProbeDelay
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

AddParts(IEnumerable<IMediaSourceProvider>)

Adds the parts.

Declaration

void AddParts(IEnumerable<IMediaSourceProvider> providers)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IMediaSourceProvider>	providers	The providers.

CloseLiveStream(String)

Closes the media source.

Declaration

Task CloseLiveStream(string id)

Parameters

Type	Name	Description
System.String	id	The live stream identifier.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

GetLiveStreamInfo(String)

Declaration

ILiveStream GetLiveStreamInfo(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
ILiveStream

GetLiveStreamInfoByUniqueId(String)

Declaration

ILiveStream GetLiveStreamInfoByUniqueId(string uniqueId)

Parameters

Type	Name	Description
System.String	uniqueId

Returns

Type	Description
ILiveStream

GetLiveStreamMediaSource(String)

Gets the live stream.

Declaration

MediaSourceInfo GetLiveStreamMediaSource(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
MediaSourceInfo

GetMediaSource(BaseItem, String, String, Boolean, CancellationToken)

Gets the static media source.

Declaration

Task<MediaSourceInfo> GetMediaSource(BaseItem item, string mediaSourceId, string liveStreamId, bool enablePathSubstitution, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
System.String	mediaSourceId
System.String	liveStreamId
System.Boolean	enablePathSubstitution
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<MediaSourceInfo>

GetMediaStreams(BaseItem)

Declaration

List<MediaStream> GetMediaStreams(BaseItem item)

Parameters

Type	Name	Description
BaseItem	item

Returns

Type	Description
System.Collections.Generic.List<MediaStream>

GetMediaStreams(BaseItem, CancellationToken)

Declaration

List<MediaStream> GetMediaStreams(BaseItem item, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Collections.Generic.List<MediaStream>

GetMediaStreams(MediaStreamQuery)

Gets the media streams.

Declaration

List<MediaStream> GetMediaStreams(MediaStreamQuery query)

Parameters

Type	Name	Description
MediaStreamQuery	query	The query.

Returns

Type	Description
System.Collections.Generic.List<MediaStream>

GetMediaStreams(MediaStreamQuery, CancellationToken)

Declaration

List<MediaStream> GetMediaStreams(MediaStreamQuery query, CancellationToken cancellationToken)

Parameters

Type	Name	Description
MediaStreamQuery	query
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Collections.Generic.List<MediaStream>

GetMediaStreams(Int64)

Gets the media streams.

Declaration

List<MediaStream> GetMediaStreams(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId	The item identifier.

Returns

Type	Description
System.Collections.Generic.List<MediaStream>

GetPathProtocol(ReadOnlySpan<Char>)

Declaration

MediaProtocol GetPathProtocol(ReadOnlySpan<char> path)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path

Returns

Type	Description
MediaProtocol

GetPlayackMediaSources(BaseItem, User, Boolean, Boolean, Boolean, CancellationToken)

Declaration

Task<List<MediaSourceInfo>> GetPlayackMediaSources(BaseItem item, User user, bool allowMediaProbe, bool enablePathSubstitution, bool fillChapters, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
User	user
System.Boolean	allowMediaProbe
System.Boolean	enablePathSubstitution
System.Boolean	fillChapters
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<MediaSourceInfo>>

GetPlayackMediaSources(BaseItem, User, Boolean, Boolean, CancellationToken)

Declaration

Task<List<MediaSourceInfo>> GetPlayackMediaSources(BaseItem item, User user, bool allowMediaProbe, bool enablePathSubstitution, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
User	user
System.Boolean	allowMediaProbe
System.Boolean	enablePathSubstitution
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<MediaSourceInfo>>

GetPlayackMediaSources(BaseItem, User, Boolean, String, Boolean, Boolean, DeviceProfile, CancellationToken)

Declaration

Task<List<MediaSourceInfo>> GetPlayackMediaSources(BaseItem item, User user, bool allowMediaProbe, string probeMediaSourceId, bool enablePathSubstitution, bool fillChapters, DeviceProfile deviceProfile, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
User	user
System.Boolean	allowMediaProbe
System.String	probeMediaSourceId
System.Boolean	enablePathSubstitution
System.Boolean	fillChapters
DeviceProfile	deviceProfile
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<MediaSourceInfo>>

GetPlayackMediaSources(BaseItem, User, Boolean, String, Boolean, Boolean, CancellationToken)

Declaration

Task<List<MediaSourceInfo>> GetPlayackMediaSources(BaseItem item, User user, bool allowMediaProbe, string probeMediaSourceId, bool enablePathSubstitution, bool fillChapters, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
User	user
System.Boolean	allowMediaProbe
System.String	probeMediaSourceId
System.Boolean	enablePathSubstitution
System.Boolean	fillChapters
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<MediaSourceInfo>>

GetStaticMediaSources(BaseItem, Boolean, Boolean, DeviceProfile, User)

Gets the static media sources.

Declaration

List<MediaSourceInfo> GetStaticMediaSources(BaseItem item, bool enablePathSubstitution, bool fillChapters, DeviceProfile deviceProfile, User user = null)

Parameters

Type	Name	Description
BaseItem	item
System.Boolean	enablePathSubstitution
System.Boolean	fillChapters
DeviceProfile	deviceProfile
User	user

Returns

Type	Description
System.Collections.Generic.List<MediaSourceInfo>

GetStaticMediaSources(BaseItem, Boolean, Boolean, Boolean, BaseItem[], LibraryOptions, DeviceProfile, User)

Declaration

List<MediaSourceInfo> GetStaticMediaSources(BaseItem item, bool enableAlternateMediaSources, bool enablePathSubstitution, bool fillChapters, BaseItem[] collectionFolders, LibraryOptions libraryOptions, DeviceProfile deviceProfile, User user = null)

Parameters

Type	Name	Description
BaseItem	item
System.Boolean	enableAlternateMediaSources
System.Boolean	enablePathSubstitution
System.Boolean	fillChapters
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
DeviceProfile	deviceProfile
User	user

Returns

Type	Description
System.Collections.Generic.List<MediaSourceInfo>

GetStaticMediaSources(BaseItem, Boolean, Boolean, Boolean, Boolean, BaseItem[], LibraryOptions, DeviceProfile, User, CancellationToken)

Declaration

List<MediaSourceInfo> GetStaticMediaSources(BaseItem item, bool enableAlternateMediaSources, bool enablePathSubstitution, bool fillMediaStreams, bool fillChapters, BaseItem[] collectionFolders, LibraryOptions libraryOptions, DeviceProfile deviceProfile, User user, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
System.Boolean	enableAlternateMediaSources
System.Boolean	enablePathSubstitution
System.Boolean	fillMediaStreams
System.Boolean	fillChapters
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
DeviceProfile	deviceProfile
User	user
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Collections.Generic.List<MediaSourceInfo>

NormalizeMediaStreams(List<MediaStream>)

Declaration

void NormalizeMediaStreams(List<MediaStream> streams)

Parameters

Type	Name	Description
System.Collections.Generic.List<MediaStream>	streams

OpenLiveStream(LiveStreamRequest, CancellationToken)

Opens the media source.

Declaration

Task<LiveStreamResponse> OpenLiveStream(LiveStreamRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
LiveStreamRequest	request	The request.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<LiveStreamResponse>	Task<MediaSourceInfo>.

OpenLiveStreamInternal(LiveStreamRequest, CancellationToken)

Declaration

Task<Tuple<LiveStreamResponse, ILiveStream>> OpenLiveStreamInternal(LiveStreamRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
LiveStreamRequest	request
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Tuple<LiveStreamResponse, ILiveStream>>

SetDefaultAudioAndSubtitleStreamIndexes(BaseItem, MediaSourceInfo[], User, CancellationToken)

Declaration

void SetDefaultAudioAndSubtitleStreamIndexes(BaseItem item, MediaSourceInfo[] sources, User user, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
MediaSourceInfo[]	sources
User	user
System.Threading.CancellationToken	cancellationToken

SupportsDirectStream(ReadOnlySpan<Char>, MediaProtocol)

Declaration

bool SupportsDirectStream(ReadOnlySpan<char> path, MediaProtocol protocol)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path
MediaProtocol	protocol

Returns

Type	Description
System.Boolean

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)