live-tv.md

Live Tv

live_tv_controller = client.live_tv

Class Name

LiveTvController

Methods

• Add Listing Provider
• Add Tuner Host
• Cancel Series Timer
• Cancel Timer
• Create Series Timer
• Create Timer
• Delete Listing Provider
• Delete Recording
• Delete Tuner Host
• Discover Tuners
• Discvover Tuners
• Get Channel
• Get Channel Mapping Options
• Get Default Listing Provider
• Get Default Timer
• Get Guide Info
• Get Lineups
• Get Live Recording File
• Get Live Stream File
• Get Live Tv Channels
• Get Live Tv Info
• Get Live Tv Programs
• Get Program
• Get Programs
• Get Recommended Programs
• Get Recording
• Get Recording Folders
• Get Recording Group
• Get Recording Groups
• Get Recordings
• Get Recordings Series
• Get Schedules Direct Countries
• Get Series Timer
• Get Series Timers
• Get Timer
• Get Timers
• Get Tuner Host Types
• Reset Tuner
• Set Channel Mapping
• Update Series Timer
• Update Timer

Add Listing Provider

Adds a listings provider.

def add_listing_provider(self,
                        pw=None,
                        validate_listings=False,
                        validate_login=False,
                        body=None)

Parameters

Parameter	Type	Tags	Description
pw	string	Query, Optional	Password.
validate_listings	bool	Query, Optional	Validate listings. Default: False
validate_login	bool	Query, Optional	Validate login. Default: False
body	ListingsProviderInfo	Body, Optional	New listings info.

Response Type

ListingsProviderInfo

Example Usage

validate_listings = False
validate_login = False

result = live_tv_controller.add_listing_provider(None, validate_listings, validate_login)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Add Tuner Host

Adds a tuner host.

def add_tuner_host(self,
                  body=None)

Parameters

Parameter	Type	Tags	Description
body	TunerHostInfo	Body, Optional	New tuner host.

Response Type

TunerHostInfo

Example Usage

result = live_tv_controller.add_tuner_host()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Cancel Series Timer

Cancels a live tv series timer.

def cancel_series_timer(self,
                       timer_id)

Parameters

Parameter	Type	Tags	Description
timer_id	string	Template, Required	Timer id.

Response Type

void

Example Usage

timer_id = 'timerId0'

result = live_tv_controller.cancel_series_timer(timer_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Cancel Timer

Cancels a live tv timer.

def cancel_timer(self,
                timer_id)

Parameters

Parameter	Type	Tags	Description
timer_id	string	Template, Required	Timer id.

Response Type

void

Example Usage

timer_id = 'timerId0'

result = live_tv_controller.cancel_timer(timer_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Create Series Timer

Creates a live tv series timer.

def create_series_timer(self,
                       body=None)

Parameters

Parameter	Type	Tags	Description
body	SeriesTimerInfoDto	Body, Optional	New series timer info.

Response Type

void

Example Usage

result = live_tv_controller.create_series_timer()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Create Timer

Creates a live tv timer.

def create_timer(self,
                body=None)

Parameters

Parameter	Type	Tags	Description
body	TimerInfoDto	Body, Optional	New timer info.

Response Type

void

Example Usage

result = live_tv_controller.create_timer()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Delete Listing Provider

Delete listing provider.

def delete_listing_provider(self,
                           id=None)

Parameters

Parameter	Type	Tags	Description
id	string	Query, Optional	Listing provider id.

Response Type

void

Example Usage

result = live_tv_controller.delete_listing_provider()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Delete Recording

Deletes a live tv recording.

def delete_recording(self,
                    recording_id)

Parameters

Parameter	Type	Tags	Description
recording_id	uuid|string	Template, Required	Recording id.

Response Type

void

Example Usage

recording_id = '000015e2-0000-0000-0000-000000000000'

result = live_tv_controller.delete_recording(recording_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Item not found.	ProblemDetailsException

Delete Tuner Host

Deletes a tuner host.

def delete_tuner_host(self,
                     id=None)

Parameters

Parameter	Type	Tags	Description
id	string	Query, Optional	Tuner host id.

Response Type

void

Example Usage

result = live_tv_controller.delete_tuner_host()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Discover Tuners

Discover tuners.

def discover_tuners(self,
                   new_devices_only=False)

Parameters

Parameter	Type	Tags	Description
new_devices_only	bool	Query, Optional	Only discover new tuners. Default: False

Response Type

List of TunerHostInfo

Example Usage

new_devices_only = False

result = live_tv_controller.discover_tuners(new_devices_only)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Discvover Tuners

Discover tuners.

def discvover_tuners(self,
                    new_devices_only=False)

Parameters

Parameter	Type	Tags	Description
new_devices_only	bool	Query, Optional	Only discover new tuners. Default: False

Response Type

List of TunerHostInfo

Example Usage

new_devices_only = False

result = live_tv_controller.discvover_tuners(new_devices_only)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Channel

Gets a live tv channel.

def get_channel(self,
               channel_id,
               user_id=None)

Parameters

Parameter	Type	Tags	Description
channel_id	uuid|string	Template, Required	Channel id.
user_id	uuid|string	Query, Optional	Optional. Attach user data.

Response Type

BaseItemDto

Example Usage

channel_id = '00001a8a-0000-0000-0000-000000000000'

result = live_tv_controller.get_channel(channel_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Channel Mapping Options

Get channel mapping options.

def get_channel_mapping_options(self,
                               provider_id=None)

Parameters

Parameter	Type	Tags	Description
provider_id	string	Query, Optional	Provider id.

Response Type

ChannelMappingOptionsDto

Example Usage

result = live_tv_controller.get_channel_mapping_options()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Default Listing Provider

Gets default listings provider info.

def get_default_listing_provider(self)

Response Type

ListingsProviderInfo

Example Usage

result = live_tv_controller.get_default_listing_provider()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Default Timer

Gets the default values for a new timer.

def get_default_timer(self,
                     program_id=None)

Parameters

Parameter	Type	Tags	Description
program_id	string	Query, Optional	Optional. To attach default values based on a program.

Response Type

SeriesTimerInfoDto

Example Usage

result = live_tv_controller.get_default_timer()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Guide Info

Get guid info.

def get_guide_info(self)

Response Type

GuideInfo

Example Usage

result = live_tv_controller.get_guide_info()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Lineups

Gets available lineups.

def get_lineups(self,
               id=None,
               mtype=None,
               location=None,
               country=None)

Parameters

Parameter	Type	Tags	Description
id	string	Query, Optional	Provider id.
mtype	string	Query, Optional	Provider type.
location	string	Query, Optional	Location.
country	string	Query, Optional	Country.

Response Type

List of NameIdPair

Example Usage

result = live_tv_controller.get_lineups()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Live Recording File

Gets a live tv recording stream.

def get_live_recording_file(self,
                           recording_id)

Parameters

Parameter	Type	Tags	Description
recording_id	string	Template, Required	Recording id.

Response Type

mixed

Example Usage

recording_id = 'recordingId2'

result = live_tv_controller.get_live_recording_file(recording_id)

Errors

HTTP Status Code	Error Description	Exception Class
404	Recording not found.	ProblemDetailsException

Get Live Stream File

Gets a live tv channel stream.

def get_live_stream_file(self,
                        stream_id,
                        container)

Parameters

Parameter	Type	Tags	Description
stream_id	string	Template, Required	Stream id.
container	string	Template, Required	Container type.

Response Type

mixed

Example Usage

stream_id = 'streamId4'
container = 'container2'

result = live_tv_controller.get_live_stream_file(stream_id, container)

Errors

HTTP Status Code	Error Description	Exception Class
404	Stream not found.	ProblemDetailsException

Get Live Tv Channels

Gets available live tv channels.

def get_live_tv_channels(self,
                        mtype=None,
                        user_id=None,
                        start_index=None,
                        is_movie=None,
                        is_series=None,
                        is_news=None,
                        is_kids=None,
                        is_sports=None,
                        limit=None,
                        is_favorite=None,
                        is_liked=None,
                        is_disliked=None,
                        enable_images=None,
                        image_type_limit=None,
                        enable_image_types=None,
                        fields=None,
                        enable_user_data=None,
                        sort_by=None,
                        sort_order=None,
                        enable_favorite_sorting=False,
                        add_current_program=True)

Parameters

Parameter	Type	Tags	Description
mtype	ChannelTypeEnum	Query, Optional	Optional. Filter by channel type.
user_id	uuid|string	Query, Optional	Optional. Filter by user and attach user data.
start_index	int	Query, Optional	Optional. The record index to start at. All items with a lower index will be dropped from the results.
is_movie	bool	Query, Optional	Optional. Filter for movies.
is_series	bool	Query, Optional	Optional. Filter for series.
is_news	bool	Query, Optional	Optional. Filter for news.
is_kids	bool	Query, Optional	Optional. Filter for kids.
is_sports	bool	Query, Optional	Optional. Filter for sports.
limit	int	Query, Optional	Optional. The maximum number of records to return.
is_favorite	bool	Query, Optional	Optional. Filter by channels that are favorites, or not.
is_liked	bool	Query, Optional	Optional. Filter by channels that are liked, or not.
is_disliked	bool	Query, Optional	Optional. Filter by channels that are disliked, or not.
enable_images	bool	Query, Optional	Optional. Include image information in output.
image_type_limit	int	Query, Optional	Optional. The max number of images to return, per image type.
enable_image_types	List of ImageTypeEnum	Query, Optional	"Optional. The image types to include in the output.
fields	List of ItemFieldsEnum	Query, Optional	Optional. Specify additional fields of information to return in the output.
enable_user_data	bool	Query, Optional	Optional. Include user data.
sort_by	List of string	Query, Optional	Optional. Key to sort by.
sort_order	SortOrderEnum	Query, Optional	Optional. Sort order.
enable_favorite_sorting	bool	Query, Optional	Optional. Incorporate favorite and like status into channel sorting. Default: False
add_current_program	bool	Query, Optional	Optional. Adds current program info to each channel. Default: True

Response Type

BaseItemDtoQueryResult

Example Usage

enable_favorite_sorting = False
add_current_program = True

result = live_tv_controller.get_live_tv_channels(None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, enable_favorite_sorting, add_current_program)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Live Tv Info

Gets available live tv services.

def get_live_tv_info(self)

Response Type

LiveTvInfo

Example Usage

result = live_tv_controller.get_live_tv_info()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Live Tv Programs

Gets available live tv epgs.

def get_live_tv_programs(self,
                        channel_ids=None,
                        user_id=None,
                        min_start_date=None,
                        has_aired=None,
                        is_airing=None,
                        max_start_date=None,
                        min_end_date=None,
                        max_end_date=None,
                        is_movie=None,
                        is_series=None,
                        is_news=None,
                        is_kids=None,
                        is_sports=None,
                        start_index=None,
                        limit=None,
                        sort_by=None,
                        sort_order=None,
                        genres=None,
                        genre_ids=None,
                        enable_images=None,
                        image_type_limit=None,
                        enable_image_types=None,
                        enable_user_data=None,
                        series_timer_id=None,
                        library_series_id=None,
                        fields=None,
                        enable_total_record_count=True)

Parameters

Parameter	Type	Tags	Description
channel_ids	List of uuid|string	Query, Optional	The channels to return guide information for.
user_id	uuid|string	Query, Optional	Optional. Filter by user id.
min_start_date	datetime	Query, Optional	Optional. The minimum premiere start date.
has_aired	bool	Query, Optional	Optional. Filter by programs that have completed airing, or not.
is_airing	bool	Query, Optional	Optional. Filter by programs that are currently airing, or not.
max_start_date	datetime	Query, Optional	Optional. The maximum premiere start date.
min_end_date	datetime	Query, Optional	Optional. The minimum premiere end date.
max_end_date	datetime	Query, Optional	Optional. The maximum premiere end date.
is_movie	bool	Query, Optional	Optional. Filter for movies.
is_series	bool	Query, Optional	Optional. Filter for series.
is_news	bool	Query, Optional	Optional. Filter for news.
is_kids	bool	Query, Optional	Optional. Filter for kids.
is_sports	bool	Query, Optional	Optional. Filter for sports.
start_index	int	Query, Optional	Optional. The record index to start at. All items with a lower index will be dropped from the results.
limit	int	Query, Optional	Optional. The maximum number of records to return.
sort_by	List of string	Query, Optional	Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
sort_order	List of SortOrderEnum	Query, Optional	Sort Order - Ascending,Descending.
genres	List of string	Query, Optional	The genres to return guide information for.
genre_ids	List of uuid|string	Query, Optional	The genre ids to return guide information for.
enable_images	bool	Query, Optional	Optional. Include image information in output.
image_type_limit	int	Query, Optional	Optional. The max number of images to return, per image type.
enable_image_types	List of ImageTypeEnum	Query, Optional	Optional. The image types to include in the output.
enable_user_data	bool	Query, Optional	Optional. Include user data.
series_timer_id	string	Query, Optional	Optional. Filter by series timer id.
library_series_id	uuid|string	Query, Optional	Optional. Filter by library series id.
fields	List of ItemFieldsEnum	Query, Optional	Optional. Specify additional fields of information to return in the output.
enable_total_record_count	bool	Query, Optional	Retrieve total record count. Default: True

Response Type

BaseItemDtoQueryResult

Example Usage

enable_total_record_count = True

result = live_tv_controller.get_live_tv_programs(None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, enable_total_record_count)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Program

Gets a live tv program.

def get_program(self,
               program_id,
               user_id=None)

Parameters

Parameter	Type	Tags	Description
program_id	string	Template, Required	Program id.
user_id	uuid|string	Query, Optional	Optional. Attach user data.

Response Type

BaseItemDto

Example Usage

program_id = 'programId8'

result = live_tv_controller.get_program(program_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Programs

Gets available live tv epgs.

def get_programs(self,
                body=None)

Parameters

Parameter	Type	Tags	Description
body	GetProgramsDto	Body, Optional	Request body.

Response Type

BaseItemDtoQueryResult

Example Usage

result = live_tv_controller.get_programs()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Recommended Programs

Gets recommended live tv epgs.

def get_recommended_programs(self,
                            user_id=None,
                            limit=None,
                            is_airing=None,
                            has_aired=None,
                            is_series=None,
                            is_movie=None,
                            is_news=None,
                            is_kids=None,
                            is_sports=None,
                            enable_images=None,
                            image_type_limit=None,
                            enable_image_types=None,
                            genre_ids=None,
                            fields=None,
                            enable_user_data=None,
                            enable_total_record_count=True)

Parameters

Parameter	Type	Tags	Description
user_id	uuid|string	Query, Optional	Optional. filter by user id.
limit	int	Query, Optional	Optional. The maximum number of records to return.
is_airing	bool	Query, Optional	Optional. Filter by programs that are currently airing, or not.
has_aired	bool	Query, Optional	Optional. Filter by programs that have completed airing, or not.
is_series	bool	Query, Optional	Optional. Filter for series.
is_movie	bool	Query, Optional	Optional. Filter for movies.
is_news	bool	Query, Optional	Optional. Filter for news.
is_kids	bool	Query, Optional	Optional. Filter for kids.
is_sports	bool	Query, Optional	Optional. Filter for sports.
enable_images	bool	Query, Optional	Optional. Include image information in output.
image_type_limit	int	Query, Optional	Optional. The max number of images to return, per image type.
enable_image_types	List of ImageTypeEnum	Query, Optional	Optional. The image types to include in the output.
genre_ids	List of uuid|string	Query, Optional	The genres to return guide information for.
fields	List of ItemFieldsEnum	Query, Optional	Optional. Specify additional fields of information to return in the output.
enable_user_data	bool	Query, Optional	Optional. include user data.
enable_total_record_count	bool	Query, Optional	Retrieve total record count. Default: True

Response Type

BaseItemDtoQueryResult

Example Usage

enable_total_record_count = True

result = live_tv_controller.get_recommended_programs(None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, enable_total_record_count)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Recording

Gets a live tv recording.

def get_recording(self,
                 recording_id,
                 user_id=None)

Parameters

Parameter	Type	Tags	Description
recording_id	uuid|string	Template, Required	Recording id.
user_id	uuid|string	Query, Optional	Optional. Attach user data.

Response Type

BaseItemDto

Example Usage

recording_id = '000015e2-0000-0000-0000-000000000000'

result = live_tv_controller.get_recording(recording_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Recording Folders

Gets recording folders.

def get_recording_folders(self,
                         user_id=None)

Parameters

Parameter	Type	Tags	Description
user_id	uuid|string	Query, Optional	Optional. Filter by user and attach user data.

Response Type

BaseItemDtoQueryResult

Example Usage

result = live_tv_controller.get_recording_folders()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Recording Group

This endpoint is deprecated.

Get recording group.

def get_recording_group(self,
                       group_id)

Parameters

Parameter	Type	Tags	Description
group_id	uuid|string	Template, Required	Group id.

Response Type

void

Example Usage

group_id = '00002262-0000-0000-0000-000000000000'

result = live_tv_controller.get_recording_group(group_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Not Found	ProblemDetailsException

Get Recording Groups

This endpoint is deprecated.

Gets live tv recording groups.

def get_recording_groups(self,
                        user_id=None)

Parameters

Parameter	Type	Tags	Description
user_id	uuid|string	Query, Optional	Optional. Filter by user and attach user data.

Response Type

BaseItemDtoQueryResult

Example Usage

result = live_tv_controller.get_recording_groups()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Recordings

Gets live tv recordings.

def get_recordings(self,
                  channel_id=None,
                  user_id=None,
                  start_index=None,
                  limit=None,
                  status=None,
                  is_in_progress=None,
                  series_timer_id=None,
                  enable_images=None,
                  image_type_limit=None,
                  enable_image_types=None,
                  fields=None,
                  enable_user_data=None,
                  is_movie=None,
                  is_series=None,
                  is_kids=None,
                  is_sports=None,
                  is_news=None,
                  is_library_item=None,
                  enable_total_record_count=True)

Parameters

Parameter	Type	Tags	Description
channel_id	string	Query, Optional	Optional. Filter by channel id.
user_id	uuid|string	Query, Optional	Optional. Filter by user and attach user data.
start_index	int	Query, Optional	Optional. The record index to start at. All items with a lower index will be dropped from the results.
limit	int	Query, Optional	Optional. The maximum number of records to return.
status	RecordingStatusEnum	Query, Optional	Optional. Filter by recording status.
is_in_progress	bool	Query, Optional	Optional. Filter by recordings that are in progress, or not.
series_timer_id	string	Query, Optional	Optional. Filter by recordings belonging to a series timer.
enable_images	bool	Query, Optional	Optional. Include image information in output.
image_type_limit	int	Query, Optional	Optional. The max number of images to return, per image type.
enable_image_types	List of ImageTypeEnum	Query, Optional	Optional. The image types to include in the output.
fields	List of ItemFieldsEnum	Query, Optional	Optional. Specify additional fields of information to return in the output.
enable_user_data	bool	Query, Optional	Optional. Include user data.
is_movie	bool	Query, Optional	Optional. Filter for movies.
is_series	bool	Query, Optional	Optional. Filter for series.
is_kids	bool	Query, Optional	Optional. Filter for kids.
is_sports	bool	Query, Optional	Optional. Filter for sports.
is_news	bool	Query, Optional	Optional. Filter for news.
is_library_item	bool	Query, Optional	Optional. Filter for is library item.
enable_total_record_count	bool	Query, Optional	Optional. Return total record count. Default: True

Response Type

BaseItemDtoQueryResult

Example Usage

enable_total_record_count = True

result = live_tv_controller.get_recordings(None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, enable_total_record_count)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Recordings Series

This endpoint is deprecated.

Gets live tv recording series.

def get_recordings_series(self,
                         channel_id=None,
                         user_id=None,
                         group_id=None,
                         start_index=None,
                         limit=None,
                         status=None,
                         is_in_progress=None,
                         series_timer_id=None,
                         enable_images=None,
                         image_type_limit=None,
                         enable_image_types=None,
                         fields=None,
                         enable_user_data=None,
                         enable_total_record_count=True)

Parameters

Parameter	Type	Tags	Description
channel_id	string	Query, Optional	Optional. Filter by channel id.
user_id	uuid|string	Query, Optional	Optional. Filter by user and attach user data.
group_id	string	Query, Optional	Optional. Filter by recording group.
start_index	int	Query, Optional	Optional. The record index to start at. All items with a lower index will be dropped from the results.
limit	int	Query, Optional	Optional. The maximum number of records to return.
status	RecordingStatusEnum	Query, Optional	Optional. Filter by recording status.
is_in_progress	bool	Query, Optional	Optional. Filter by recordings that are in progress, or not.
series_timer_id	string	Query, Optional	Optional. Filter by recordings belonging to a series timer.
enable_images	bool	Query, Optional	Optional. Include image information in output.
image_type_limit	int	Query, Optional	Optional. The max number of images to return, per image type.
enable_image_types	List of ImageTypeEnum	Query, Optional	Optional. The image types to include in the output.
fields	List of ItemFieldsEnum	Query, Optional	Optional. Specify additional fields of information to return in the output.
enable_user_data	bool	Query, Optional	Optional. Include user data.
enable_total_record_count	bool	Query, Optional	Optional. Return total record count. Default: True

Response Type

BaseItemDtoQueryResult

Example Usage

enable_total_record_count = True

result = live_tv_controller.get_recordings_series(None, None, None, None, None, None, None, None, None, None, None, None, None, enable_total_record_count)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Schedules Direct Countries

Gets available countries.

def get_schedules_direct_countries(self)

Response Type

binary

Example Usage

result = live_tv_controller.get_schedules_direct_countries()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Series Timer

Gets a live tv series timer.

def get_series_timer(self,
                    timer_id)

Parameters

Parameter	Type	Tags	Description
timer_id	string	Template, Required	Timer id.

Response Type

SeriesTimerInfoDto

Example Usage

timer_id = 'timerId0'

result = live_tv_controller.get_series_timer(timer_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Series timer not found.	ProblemDetailsException

Get Series Timers

Gets live tv series timers.

def get_series_timers(self,
                     sort_by=None,
                     sort_order=None)

Parameters

Parameter	Type	Tags	Description
sort_by	string	Query, Optional	Optional. Sort by SortName or Priority.
sort_order	SortOrderEnum	Query, Optional	Optional. Sort in Ascending or Descending order.

Response Type

SeriesTimerInfoDtoQueryResult

Example Usage

result = live_tv_controller.get_series_timers()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Timer

Gets a timer.

def get_timer(self,
             timer_id)

Parameters

Parameter	Type	Tags	Description
timer_id	string	Template, Required	Timer id.

Response Type

TimerInfoDto

Example Usage

timer_id = 'timerId0'

result = live_tv_controller.get_timer(timer_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Timers

Gets the live tv timers.

def get_timers(self,
              channel_id=None,
              series_timer_id=None,
              is_active=None,
              is_scheduled=None)

Parameters

Parameter	Type	Tags	Description
channel_id	string	Query, Optional	Optional. Filter by channel id.
series_timer_id	string	Query, Optional	Optional. Filter by timers belonging to a series timer.
is_active	bool	Query, Optional	Optional. Filter by timers that are active.
is_scheduled	bool	Query, Optional	Optional. Filter by timers that are scheduled.

Response Type

TimerInfoDtoQueryResult

Example Usage

result = live_tv_controller.get_timers()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Tuner Host Types

Get tuner host types.

def get_tuner_host_types(self)

Response Type

List of NameIdPair

Example Usage

result = live_tv_controller.get_tuner_host_types()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Reset Tuner

Resets a tv tuner.

def reset_tuner(self,
               tuner_id)

Parameters

Parameter	Type	Tags	Description
tuner_id	string	Template, Required	Tuner id.

Response Type

void

Example Usage

tuner_id = 'tunerId2'

result = live_tv_controller.reset_tuner(tuner_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Set Channel Mapping

Set channel mappings.

def set_channel_mapping(self,
                       body)

Parameters

Parameter	Type	Tags	Description
body	SetChannelMappingDto	Body, Required	The set channel mapping dto.

Response Type

TunerChannelMapping

Example Usage

body = SetChannelMappingDto()
body.provider_id = 'ProviderId8'
body.tuner_channel_id = 'TunerChannelId8'
body.provider_channel_id = 'ProviderChannelId6'

result = live_tv_controller.set_channel_mapping(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Update Series Timer

Updates a live tv series timer.

def update_series_timer(self,
                       timer_id,
                       body=None)

Parameters

Parameter	Type	Tags	Description
timer_id	string	Template, Required	Timer id.
body	SeriesTimerInfoDto	Body, Optional	New series timer info.

Response Type

void

Example Usage

timer_id = 'timerId0'

result = live_tv_controller.update_series_timer(timer_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Update Timer

Updates a live tv timer.

def update_timer(self,
                timer_id,
                body=None)

Parameters

Parameter	Type	Tags	Description
timer_id	string	Template, Required	Timer id.
body	TimerInfoDto	Body, Optional	New timer info.

Response Type

void

Example Usage

timer_id = 'timerId0'

result = live_tv_controller.update_timer(timer_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException