Class KodiPVRNamespace

Index

Constructors

Methods

AddTimer DeleteTimer GetBroadcastDetails GetBroadcastIsPlayable GetBroadcasts GetChannelDetails GetChannelGroupDetails GetChannelGroups GetChannels GetClients GetProperties GetRecordingDetails GetRecordings GetTimerDetails GetTimers Record Scan ToggleTimer

Constructors

constructor

new KodiPVRNamespace(sendMessage: ISendMessage): KodiPVRNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiPVRNamespace
- Defined in namespaces/pvr.ts:64

Methods

AddTimer

AddTimer(timer: Timer): Promise<string>
Adds a new timer.
Parameters
- timer: Timer
  The timer object to add.
Returns Promise<string>
A promise resolving to the ID of the added timer.
- Defined in namespaces/pvr.ts:74

DeleteTimer

DeleteTimer(timerid: string): Promise<boolean>
Deletes an existing timer.
Parameters
- timerid: string
  The ID of the timer to delete.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/pvr.ts:85

GetBroadcastDetails

GetBroadcastDetails(broadcastid: number): Promise<BroadcastDetails>
Retrieves detailed information about a specific broadcast.
Parameters
- broadcastid: number
  The ID of the broadcast.
Returns Promise<BroadcastDetails>
A promise resolving to the BroadcastDetails object.
- Defined in namespaces/pvr.ts:96

GetBroadcastIsPlayable

GetBroadcastIsPlayable(broadcastid: number): Promise<boolean>
Checks if a specific broadcast is playable.
Parameters
- broadcastid: number
  The ID of the broadcast.
Returns Promise<boolean>
A promise resolving to a boolean indicating if the broadcast is playable.
- Defined in namespaces/pvr.ts:109

GetBroadcasts

GetBroadcasts(params: PVRGetBroadcastsParams): Promise<PVRGetBroadcastsResponse>
Retrieves a list of broadcasts with optional filtering and pagination.
Parameters
- params: PVRGetBroadcastsParams
  The parameters to filter and paginate broadcasts.
Returns Promise<PVRGetBroadcastsResponse>
A promise resolving to the list of broadcasts and pagination details.
- Defined in namespaces/pvr.ts:122

GetChannelDetails

GetChannelDetails(channelid: number): Promise<ChannelDetails>
Retrieves detailed information about a specific channel.
Parameters
- channelid: number
  The ID of the channel.
Returns Promise<ChannelDetails>
A promise resolving to the ChannelDetails object.
- Defined in namespaces/pvr.ts:134

GetChannelGroupDetails

GetChannelGroupDetails(channelgroupid: number): Promise<ChannelGroupDetails>
Retrieves detailed information about a specific channel group.
Parameters
- channelgroupid: number
  The ID of the channel group.
Returns Promise<ChannelGroupDetails>
A promise resolving to the ChannelGroupDetails object.
- Defined in namespaces/pvr.ts:147

GetChannelGroups

GetChannelGroups(
params: PVRGetChannelGroupsParams,
): Promise<PVRGetChannelGroupsResponse>
Retrieves a list of channel groups with optional filtering and pagination.
Parameters
- params: PVRGetChannelGroupsParams
  The parameters to filter and paginate channel groups.
Returns Promise<PVRGetChannelGroupsResponse>
A promise resolving to the list of channel groups and pagination details.
- Defined in namespaces/pvr.ts:160

GetChannels

GetChannels(params: PVRGetChannelsParams): Promise<PVRGetChannelsResponse>
Retrieves a list of channels with optional filtering and pagination.
Parameters
- params: PVRGetChannelsParams
  The parameters to filter and paginate channels.
Returns Promise<PVRGetChannelsResponse>
A promise resolving to the list of channels and pagination details.
- Defined in namespaces/pvr.ts:172

GetClients

GetClients(): Promise<PVRGetClientsResponse>
Retrieves a list of PVR clients.

Returns Promise<PVRGetClientsResponse>
A promise resolving to the list of PVR clients.
- Defined in namespaces/pvr.ts:183

GetProperties

GetProperties(properties: PVRProperty[]): Promise<PVRProperties>
Retrieves specified properties for PVR.
Parameters
- properties: PVRProperty[]
  The list of properties to retrieve.
Returns Promise<PVRProperties>
A promise resolving to the requested properties and their values.
- Defined in namespaces/pvr.ts:193

GetRecordingDetails

GetRecordingDetails(recordingid: number): Promise<RecordingDetails>
Retrieves detailed information about a specific recording.
Parameters
- recordingid: number
  The ID of the recording.
Returns Promise<RecordingDetails>
A promise resolving to the RecordingDetails object.
- Defined in namespaces/pvr.ts:206

GetRecordings

GetRecordings(params: PVRGetRecordingsParams): Promise<PVRGetRecordingsResponse>
Retrieves a list of recordings with optional filtering and pagination.
Parameters
- params: PVRGetRecordingsParams
  The parameters to filter and paginate recordings.
Returns Promise<PVRGetRecordingsResponse>
A promise resolving to the list of recordings and pagination details.
- Defined in namespaces/pvr.ts:219

GetTimerDetails

GetTimerDetails(timerid: string): Promise<Timer>
Retrieves detailed information about a specific timer.
Parameters
- timerid: string
  The ID of the timer.
Returns Promise<Timer>
A promise resolving to the Timer object.
- Defined in namespaces/pvr.ts:231

GetTimers

GetTimers(params: PVRGetTimersParams): Promise<PVRGetTimersResponse>
Retrieves a list of timers with optional filtering and pagination.
Parameters
- params: PVRGetTimersParams
  The parameters to filter and paginate timers.
Returns Promise<PVRGetTimersResponse>
A promise resolving to the list of timers and pagination details.
- Defined in namespaces/pvr.ts:242

Record

Record(
    channelid: number,
    title: string,
    starttime: string,
    endtime: string,
): Promise<RecordingDetails>
Initiates a recording on a specified channel.
Parameters
- channelid: number
  The ID of the channel to record from.
- title: string
  The title of the recording.
- starttime: string
  The start time of the recording in ISO 8601 format.
- endtime: string
  The end time of the recording in ISO 8601 format.
Returns Promise<RecordingDetails>
A promise resolving to the details of the created recording.
- Defined in namespaces/pvr.ts:255

Scan

Scan(clientid: number, reset?: boolean): Promise<boolean>
Initiates a scan for new recordings or channels.
Parameters
- clientid: number
  The ID of the PVR client to scan.
- reset: boolean = false
  Whether to reset the existing database before scanning (optional).
Returns Promise<boolean>
A promise resolving to a boolean indicating if the scan was successful.
- Defined in namespaces/pvr.ts:272

ToggleTimer

ToggleTimer(timerid: string): Promise<boolean>
Toggles the enabled state of a specific timer.
Parameters
- timerid: string
  The ID of the timer to toggle.
Returns Promise<boolean>
A promise resolving to a boolean indicating if the toggle was successful.
- Defined in namespaces/pvr.ts:286

Class KodiPVRNamespace

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns KodiPVRNamespace

Methods

AddTimer

Parameters

Returns Promise<string>

DeleteTimer

Parameters

Returns Promise<boolean>

GetBroadcastDetails

Parameters

Returns Promise<BroadcastDetails>

GetBroadcastIsPlayable

Parameters

Returns Promise<boolean>

GetBroadcasts

Parameters

Returns Promise<PVRGetBroadcastsResponse>

GetChannelDetails

Parameters

Returns Promise<ChannelDetails>

GetChannelGroupDetails

Parameters

Returns Promise<ChannelGroupDetails>

GetChannelGroups

Parameters

Returns Promise<PVRGetChannelGroupsResponse>

GetChannels

Parameters

Returns Promise<PVRGetChannelsResponse>

GetClients

Returns Promise<PVRGetClientsResponse>

GetProperties

Parameters

Returns Promise<PVRProperties>

GetRecordingDetails

Parameters

Returns Promise<RecordingDetails>

GetRecordings

Parameters

Returns Promise<PVRGetRecordingsResponse>

GetTimerDetails

Parameters

Returns Promise<Timer>

GetTimers

Parameters

Returns Promise<PVRGetTimersResponse>

Record

Parameters

Returns Promise<RecordingDetails>

Scan

Parameters

Returns Promise<boolean>

ToggleTimer

Parameters

Returns Promise<boolean>

Settings

On This Page