Skip to content

Latest commit

 

History

History
166 lines (117 loc) · 5.11 KB

ChannelServiceApi.md

File metadata and controls

166 lines (117 loc) · 5.11 KB
Raw

embyapi.ChannelServiceApi

All URIs are relative to https://home.ourflix.de:32865/emby

Method HTTP request Description
get_channels GET /Channels Gets available channels
get_channels_by_id_items GET /Channels/{Id}/Items Gets channel items
get_channels_items_latest GET /Channels/Items/Latest Gets channel items

get_channels

QueryResultBaseItemDto get_channels(user_id=user_id, start_index=start_index, limit=limit)

Gets available channels

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.ChannelServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id (optional)
start_index = 56 # int | Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional)
limit = 56 # int | Optional. The maximum number of records to return (optional)

try:
    # Gets available channels
    api_response = api_instance.get_channels(user_id=user_id, start_index=start_index, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChannelServiceApi->get_channels: %s\n" % e)

Parameters

Name Type Description Notes
user_id str User Id [optional]
start_index int Optional. The record index to start at. All items with a lower index will be dropped from the results. [optional]
limit int Optional. The maximum number of records to return [optional]

Return type

QueryResultBaseItemDto

Authorization

apikeyauth, embyauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_channels_by_id_items

get_channels_by_id_items()

Gets channel items

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.ChannelServiceApi(embyapi.ApiClient(configuration))

try:
    # Gets channel items
    api_instance.get_channels_by_id_items()
except ApiException as e:
    print("Exception when calling ChannelServiceApi->get_channels_by_id_items: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_channels_items_latest

get_channels_items_latest()

Gets channel items

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.ChannelServiceApi(embyapi.ApiClient(configuration))

try:
    # Gets channel items
    api_instance.get_channels_items_latest()
except ApiException as e:
    print("Exception when calling ChannelServiceApi->get_channels_items_latest: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]