Interface ILiveTvManager

Manages all live tv services installed on the server

Namespace: MediaBrowser.Controller.LiveTv
Assembly: MediaBrowser.Controller.dll
Syntax
public interface ILiveTvManager

Properties

HasActiveRecording

Declaration
bool HasActiveRecording { get; }
Property Value
Type Description
System.Boolean

ListingProviders

Declaration
IListingsProvider[] ListingProviders { get; }
Property Value
Type Description
IListingsProvider[]

Methods

AddChannelInfo(BaseItemDto[], Int64[], DtoOptions, User)

Declaration
void AddChannelInfo(BaseItemDto[] dtos, long[] channelIds, DtoOptions options, User user)
Parameters
Type Name Description
BaseItemDto[] dtos
System.Int64[] channelIds
DtoOptions options
User user

AddInfoToProgramDto(List<Tuple<BaseItem, BaseItemDto>>, DtoOptions, User)

Adds the information to program dto.

Declaration
void AddInfoToProgramDto(List<Tuple<BaseItem, BaseItemDto>> programs, DtoOptions options, User user = null)
Parameters
Type Name Description
System.Collections.Generic.List<System.Tuple<BaseItem, BaseItemDto>> programs

The programs.
DtoOptions options

The options.
User user

The user.

AddInfoToRecordingDto(BaseItem, BaseItemDto, ActiveRecordingInfo, User)

Declaration
void AddInfoToRecordingDto(BaseItem item, BaseItemDto dto, ActiveRecordingInfo activeRecordingInfo, User user = null)
Parameters
Type Name Description
BaseItem item
BaseItemDto dto
ActiveRecordingInfo activeRecordingInfo
User user

AddParts(IEnumerable<ITunerHost>, IEnumerable<IListingsProvider>)

Adds the parts.

Declaration
void AddParts(IEnumerable<ITunerHost> tunerHosts, IEnumerable<IListingsProvider> listingProviders)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ITunerHost> tunerHosts
System.Collections.Generic.IEnumerable<IListingsProvider> listingProviders

CancelSeriesTimer(String)

Cancels the series timer.

Declaration
void CancelSeriesTimer(string id)
Parameters
Type Name Description
System.String id

The identifier.

CancelTimer(String)

Cancels the timer.

Declaration
void CancelTimer(string id)
Parameters
Type Name Description
System.String id

The identifier.

CreateLiveStream(LiveStreamOptions)

Declaration
ILiveStream CreateLiveStream(LiveStreamOptions options)
Parameters
Type Name Description
LiveStreamOptions options
Returns
Type Description
ILiveStream

CreateSeriesTimer(SeriesTimerInfo, CancellationToken)

Creates the series timer.

Declaration
Task CreateSeriesTimer(SeriesTimerInfo timer, CancellationToken cancellationToken)
Parameters
Type Name Description
SeriesTimerInfo timer

The timer.
System.Threading.CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
System.Threading.Tasks.Task

Task.

CreateTimer(TimerInfoDto)

Creates the timer.

Declaration
void CreateTimer(TimerInfoDto timer)
Parameters
Type Name Description
TimerInfoDto timer

DeleteListingsProvider(String)

Declaration
void DeleteListingsProvider(string id)
Parameters
Type Name Description
System.String id

DeleteTunerHost(String)

Declaration
Task DeleteTunerHost(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
System.Threading.Tasks.Task

DiscoverTuners(Boolean, CancellationToken)

Declaration
Task<List<TunerHostInfo>> DiscoverTuners(bool newDevicesOnly, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Boolean newDevicesOnly
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TunerHostInfo>>

GetActiveRecordingInfo(BaseItem)

Declaration
ActiveRecordingInfo GetActiveRecordingInfo(BaseItem item)
Parameters
Type Name Description
BaseItem item
Returns
Type Description
ActiveRecordingInfo

GetActiveRecordingInfo(String)

Declaration
ActiveRecordingInfo GetActiveRecordingInfo(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
ActiveRecordingInfo

GetChannelMediaSources(BaseItem, CancellationToken)

Gets the channel media sources.

Declaration
Task<List<MediaSourceInfo>> GetChannelMediaSources(BaseItem item, CancellationToken cancellationToken)
Parameters
Type Name Description
BaseItem item
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<MediaSourceInfo>>

GetChannelsFromListingsProviderData(String, CancellationToken)

Declaration
Task<List<ChannelInfo>> GetChannelsFromListingsProviderData(string id, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String id
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ChannelInfo>>

GetGuideInfo()

Gets the guide information.

Declaration
GuideInfo GetGuideInfo()
Returns
Type Description
GuideInfo

GuideInfo.

GetInternalChannels(InternalItemsQuery, Boolean, CancellationToken)

Gets the internal channels.

Declaration
QueryResult<BaseItem> GetInternalChannels(InternalItemsQuery internalQuery, bool enableFavoriteSorting, CancellationToken cancellationToken)
Parameters
Type Name Description
InternalItemsQuery internalQuery
System.Boolean enableFavoriteSorting
System.Threading.CancellationToken cancellationToken
Returns
Type Description
QueryResult<BaseItem>

GetInternalLiveTvFolder(Boolean)

Gets the live tv folder.

Declaration
Folder GetInternalLiveTvFolder(bool createIfNotFound)
Parameters
Type Name Description
System.Boolean createIfNotFound
Returns
Type Description
Folder

GetInternalLiveTvFolderId(Boolean)

Declaration
long GetInternalLiveTvFolderId(bool createIfNotFound)
Parameters
Type Name Description
System.Boolean createIfNotFound
Returns
Type Description
System.Int64

GetLineups(String, String, String, String, CancellationToken)

Gets the lineups.

Declaration
Task<List<NameIdPair>> GetLineups(string providerType, string providerId, string country, string location, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String providerType

Type of the provider.
System.String providerId

The provider identifier.
System.String country

The country.
System.String location

The location.
System.Threading.CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<NameIdPair>>

Task<List<NameIdPair>>.

GetLiveTvInfo(CancellationToken)

Gets the live tv information.

Declaration
LiveTvInfo GetLiveTvInfo(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
LiveTvInfo

Task{LiveTvInfo}.

GetNewTimerDefaults()

Gets the new timer defaults asynchronous.

Declaration
SeriesTimerInfoDto GetNewTimerDefaults()
Returns
Type Description
SeriesTimerInfoDto

Task{TimerInfo}.

GetNewTimerDefaults(String)

Gets the new timer defaults.

Declaration
SeriesTimerInfoDto GetNewTimerDefaults(string programId)
Parameters
Type Name Description
System.String programId
Returns
Type Description
SeriesTimerInfoDto

Task{SeriesTimerInfoDto}.

GetPrograms(InternalItemsQuery)

Gets the programs.

Declaration
QueryResult<BaseItemDto> GetPrograms(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<BaseItemDto>

GetRecommendedPrograms(InternalItemsQuery)

Gets the recommended programs.

Declaration
QueryResult<BaseItemDto> GetRecommendedPrograms(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query

The query.
Returns
Type Description
QueryResult<BaseItemDto>

GetRecordings(InternalItemsQuery)

Gets the recordings.

Declaration
QueryResult<BaseItemDto> GetRecordings(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<BaseItemDto>

GetSeriesTimer(ReadOnlyMemory<Char>)

Gets the series timer.

Declaration
SeriesTimerInfoDto GetSeriesTimer(ReadOnlyMemory<char> id)
Parameters
Type Name Description
System.ReadOnlyMemory<System.Char> id
Returns
Type Description
SeriesTimerInfoDto

Task{TimerInfoDto}.

GetSeriesTimerInfoDto(SeriesTimerInfo)

Declaration
SeriesTimerInfoDto GetSeriesTimerInfoDto(SeriesTimerInfo seriesTimer)
Parameters
Type Name Description
SeriesTimerInfo seriesTimer
Returns
Type Description
SeriesTimerInfoDto

GetSeriesTimers(SeriesTimerQuery)

Gets the series timers.

Declaration
QueryResult<SeriesTimerInfoDto> GetSeriesTimers(SeriesTimerQuery query)
Parameters
Type Name Description
SeriesTimerQuery query
Returns
Type Description
QueryResult<SeriesTimerInfoDto>

Task{QueryResult{SeriesTimerInfoDto}}.

GetTimer(ReadOnlyMemory<Char>)

Gets the timer.

Declaration
TimerInfoDto GetTimer(ReadOnlyMemory<char> id)
Parameters
Type Name Description
System.ReadOnlyMemory<System.Char> id

The identifier.
Returns
Type Description
TimerInfoDto

Task{TimerInfoDto}.

GetTimerInfoDto(TimerInfo, LiveTvProgram)

Declaration
TimerInfoDto GetTimerInfoDto(TimerInfo timer, LiveTvProgram program)
Parameters
Type Name Description
TimerInfo timer
LiveTvProgram program
Returns
Type Description
TimerInfoDto

GetTimers(TimerQuery)

Gets the timers.

Declaration
QueryResult<TimerInfoDto> GetTimers(TimerQuery query)
Parameters
Type Name Description
TimerQuery query

The query.
Returns
Type Description
QueryResult<TimerInfoDto>

Task{QueryResult{TimerInfoDto}}.

GetTunerHostInfo(String)

Declaration
TunerHostInfo GetTunerHostInfo(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
TunerHostInfo

GetTunerHostInfos(String)

Declaration
List<TunerHostInfo> GetTunerHostInfos(string type)
Parameters
Type Name Description
System.String type
Returns
Type Description
System.Collections.Generic.List<TunerHostInfo>

HasActiveRecordingInDirectory(String)

Declaration
bool HasActiveRecordingInDirectory(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.Boolean

IsLiveTvEnabled(User)

Gets the enabled users.

Declaration
bool IsLiveTvEnabled(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean

SaveListingProvider(ListingsProviderInfo, Boolean, Boolean, CancellationToken)

Saves the listing provider.

Declaration
Task<ListingsProviderInfo> SaveListingProvider(ListingsProviderInfo info, bool validateLogin, bool validateListings, CancellationToken cancellationToken)
Parameters
Type Name Description
ListingsProviderInfo info

The information.
System.Boolean validateLogin

if set to true [validate login].
System.Boolean validateListings

if set to true [validate listings].
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<ListingsProviderInfo>

Task.

SaveTunerHost(TunerHostInfo, CancellationToken)

Saves the tuner host.

Declaration
Task<TunerHostInfo> SaveTunerHost(TunerHostInfo info, CancellationToken cancellationToken)
Parameters
Type Name Description
TunerHostInfo info
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<TunerHostInfo>

SetChannelMapping(String, String, String, CancellationToken)

Declaration
Task<TunerChannelMapping> SetChannelMapping(string providerId, string tunerChannelNumber, string providerChannelNumber, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String providerId
System.String tunerChannelNumber
System.String providerChannelNumber
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<TunerChannelMapping>

UpdateSeriesTimer(SeriesTimerInfo)

Updates the timer.

Declaration
Task UpdateSeriesTimer(SeriesTimerInfo timer)
Parameters
Type Name Description
SeriesTimerInfo timer

The timer.
Returns
Type Description
System.Threading.Tasks.Task

Task.

UpdateTimer(TimerInfoDto)

Updates the timer.

Declaration
void UpdateTimer(TimerInfoDto timer)
Parameters
Type Name Description
TimerInfoDto timer

Events

RecordingEnded

Declaration
event EventHandler<GenericEventArgs<ActiveRecordingInfo>> RecordingEnded
Event Type
Type Description
System.EventHandler<GenericEventArgs<ActiveRecordingInfo>>

RecordingStarted

Declaration
event EventHandler<GenericEventArgs<ActiveRecordingInfo>> RecordingStarted
Event Type
Type Description
System.EventHandler<GenericEventArgs<ActiveRecordingInfo>>

SeriesTimerCancelled

Declaration
event EventHandler<GenericEventArgs<SeriesTimerEventInfo>> SeriesTimerCancelled
Event Type
Type Description
System.EventHandler<GenericEventArgs<SeriesTimerEventInfo>>

SeriesTimerCreated

Declaration
event EventHandler<GenericEventArgs<SeriesTimerEventInfo>> SeriesTimerCreated
Event Type
Type Description
System.EventHandler<GenericEventArgs<SeriesTimerEventInfo>>

SeriesTimerUpdated

Declaration
event EventHandler<GenericEventArgs<SeriesTimerEventInfo>> SeriesTimerUpdated
Event Type
Type Description
System.EventHandler<GenericEventArgs<SeriesTimerEventInfo>>

TimerCancelled

Declaration
event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCancelled
Event Type
Type Description
System.EventHandler<GenericEventArgs<TimerEventInfo>>

TimerCreated

Declaration
event EventHandler<GenericEventArgs<TimerEventInfo>> TimerCreated
Event Type
Type Description
System.EventHandler<GenericEventArgs<TimerEventInfo>>

TimerUpdated

Declaration
event EventHandler<GenericEventArgs<TimerEventInfo>> TimerUpdated
Event Type
Type Description
System.EventHandler<GenericEventArgs<TimerEventInfo>>

Extension Methods