jellyfin.generated.api_10_11.SyncPlayApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| sync_play_buffering | POST /SyncPlay/Buffering | Notify SyncPlay group that member is buffering. |
| sync_play_create_group | POST /SyncPlay/New | Create a new SyncPlay group. |
| sync_play_get_group | GET /SyncPlay/{id} | Gets a SyncPlay group by id. |
| sync_play_get_groups | GET /SyncPlay/List | Gets all SyncPlay groups. |
| sync_play_join_group | POST /SyncPlay/Join | Join an existing SyncPlay group. |
| sync_play_leave_group | POST /SyncPlay/Leave | Leave the joined SyncPlay group. |
| sync_play_move_playlist_item | POST /SyncPlay/MovePlaylistItem | Request to move an item in the playlist in SyncPlay group. |
| sync_play_next_item | POST /SyncPlay/NextItem | Request next item in SyncPlay group. |
| sync_play_pause | POST /SyncPlay/Pause | Request pause in SyncPlay group. |
| sync_play_ping | POST /SyncPlay/Ping | Update session ping. |
| sync_play_previous_item | POST /SyncPlay/PreviousItem | Request previous item in SyncPlay group. |
| sync_play_queue | POST /SyncPlay/Queue | Request to queue items to the playlist of a SyncPlay group. |
| sync_play_ready | POST /SyncPlay/Ready | Notify SyncPlay group that member is ready for playback. |
| sync_play_remove_from_playlist | POST /SyncPlay/RemoveFromPlaylist | Request to remove items from the playlist in SyncPlay group. |
| sync_play_seek | POST /SyncPlay/Seek | Request seek in SyncPlay group. |
| sync_play_set_ignore_wait | POST /SyncPlay/SetIgnoreWait | Request SyncPlay group to ignore member during group-wait. |
| sync_play_set_new_queue | POST /SyncPlay/SetNewQueue | Request to set new playlist in SyncPlay group. |
| sync_play_set_playlist_item | POST /SyncPlay/SetPlaylistItem | Request to change playlist item in SyncPlay group. |
| sync_play_set_repeat_mode | POST /SyncPlay/SetRepeatMode | Request to set repeat mode in SyncPlay group. |
| sync_play_set_shuffle_mode | POST /SyncPlay/SetShuffleMode | Request to set shuffle mode in SyncPlay group. |
| sync_play_stop | POST /SyncPlay/Stop | Request stop in SyncPlay group. |
| sync_play_unpause | POST /SyncPlay/Unpause | Request unpause in SyncPlay group. |
sync_play_buffering
sync_play_buffering(buffer_request_dto)
Notify SyncPlay group that member is buffering.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.buffer_request_dto import BufferRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
buffer_request_dto = jellyfin.generated.api_10_11.BufferRequestDto() # BufferRequestDto | The player status.
try:
# Notify SyncPlay group that member is buffering.
api_instance.sync_play_buffering(buffer_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_buffering: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| buffer_request_dto | BufferRequestDto | The player status. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Group state update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_create_group
GroupInfoDto sync_play_create_group(new_group_request_dto)
Create a new SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.group_info_dto import GroupInfoDto
from jellyfin.generated.api_10_11.models.new_group_request_dto import NewGroupRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
new_group_request_dto = jellyfin.generated.api_10_11.NewGroupRequestDto() # NewGroupRequestDto | The settings of the new group.
try:
# Create a new SyncPlay group.
api_response = api_instance.sync_play_create_group(new_group_request_dto)
print("The response of SyncPlayApi->sync_play_create_group:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_create_group: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| new_group_request_dto | NewGroupRequestDto | The settings of the new group. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 204 | New group created. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_get_group
GroupInfoDto sync_play_get_group(id)
Gets a SyncPlay group by id.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.group_info_dto import GroupInfoDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
id = 'id_example' # str | The id of the group.
try:
# Gets a SyncPlay group by id.
api_response = api_instance.sync_play_get_group(id)
print("The response of SyncPlayApi->sync_play_get_group:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_get_group: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the group. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Group returned. | - |
| 404 | Not Found | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_get_groups
List[GroupInfoDto] sync_play_get_groups()
Gets all SyncPlay groups.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.group_info_dto import GroupInfoDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
try:
# Gets all SyncPlay groups.
api_response = api_instance.sync_play_get_groups()
print("The response of SyncPlayApi->sync_play_get_groups:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_get_groups: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Groups returned. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_join_group
sync_play_join_group(join_group_request_dto)
Join an existing SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.join_group_request_dto import JoinGroupRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
join_group_request_dto = jellyfin.generated.api_10_11.JoinGroupRequestDto() # JoinGroupRequestDto | The group to join.
try:
# Join an existing SyncPlay group.
api_instance.sync_play_join_group(join_group_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_join_group: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| join_group_request_dto | JoinGroupRequestDto | The group to join. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Group join successful. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_leave_group
sync_play_leave_group()
Leave the joined SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
try:
# Leave the joined SyncPlay group.
api_instance.sync_play_leave_group()
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_leave_group: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Group leave successful. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_move_playlist_item
sync_play_move_playlist_item(move_playlist_item_request_dto)
Request to move an item in the playlist in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.move_playlist_item_request_dto import MovePlaylistItemRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
move_playlist_item_request_dto = jellyfin.generated.api_10_11.MovePlaylistItemRequestDto() # MovePlaylistItemRequestDto | The new position for the item.
try:
# Request to move an item in the playlist in SyncPlay group.
api_instance.sync_play_move_playlist_item(move_playlist_item_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_move_playlist_item: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| move_playlist_item_request_dto | MovePlaylistItemRequestDto | The new position for the item. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Queue update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_next_item
sync_play_next_item(next_item_request_dto)
Request next item in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.next_item_request_dto import NextItemRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
next_item_request_dto = jellyfin.generated.api_10_11.NextItemRequestDto() # NextItemRequestDto | The current item information.
try:
# Request next item in SyncPlay group.
api_instance.sync_play_next_item(next_item_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_next_item: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| next_item_request_dto | NextItemRequestDto | The current item information. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Next item update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_pause
sync_play_pause()
Request pause in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
try:
# Request pause in SyncPlay group.
api_instance.sync_play_pause()
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_pause: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Pause update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_ping
sync_play_ping(ping_request_dto)
Update session ping.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.ping_request_dto import PingRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
ping_request_dto = jellyfin.generated.api_10_11.PingRequestDto() # PingRequestDto | The new ping.
try:
# Update session ping.
api_instance.sync_play_ping(ping_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_ping: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ping_request_dto | PingRequestDto | The new ping. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Ping updated. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_previous_item
sync_play_previous_item(previous_item_request_dto)
Request previous item in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.previous_item_request_dto import PreviousItemRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
previous_item_request_dto = jellyfin.generated.api_10_11.PreviousItemRequestDto() # PreviousItemRequestDto | The current item information.
try:
# Request previous item in SyncPlay group.
api_instance.sync_play_previous_item(previous_item_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_previous_item: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| previous_item_request_dto | PreviousItemRequestDto | The current item information. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Previous item update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_queue
sync_play_queue(queue_request_dto)
Request to queue items to the playlist of a SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.queue_request_dto import QueueRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
queue_request_dto = jellyfin.generated.api_10_11.QueueRequestDto() # QueueRequestDto | The items to add.
try:
# Request to queue items to the playlist of a SyncPlay group.
api_instance.sync_play_queue(queue_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_queue: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| queue_request_dto | QueueRequestDto | The items to add. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Queue update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_ready
sync_play_ready(ready_request_dto)
Notify SyncPlay group that member is ready for playback.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.ready_request_dto import ReadyRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
ready_request_dto = jellyfin.generated.api_10_11.ReadyRequestDto() # ReadyRequestDto | The player status.
try:
# Notify SyncPlay group that member is ready for playback.
api_instance.sync_play_ready(ready_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_ready: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ready_request_dto | ReadyRequestDto | The player status. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Group state update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_remove_from_playlist
sync_play_remove_from_playlist(remove_from_playlist_request_dto)
Request to remove items from the playlist in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.remove_from_playlist_request_dto import RemoveFromPlaylistRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
remove_from_playlist_request_dto = jellyfin.generated.api_10_11.RemoveFromPlaylistRequestDto() # RemoveFromPlaylistRequestDto | The items to remove.
try:
# Request to remove items from the playlist in SyncPlay group.
api_instance.sync_play_remove_from_playlist(remove_from_playlist_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_remove_from_playlist: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| remove_from_playlist_request_dto | RemoveFromPlaylistRequestDto | The items to remove. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Queue update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_seek
sync_play_seek(seek_request_dto)
Request seek in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.seek_request_dto import SeekRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
seek_request_dto = jellyfin.generated.api_10_11.SeekRequestDto() # SeekRequestDto | The new playback position.
try:
# Request seek in SyncPlay group.
api_instance.sync_play_seek(seek_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_seek: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| seek_request_dto | SeekRequestDto | The new playback position. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Seek update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_set_ignore_wait
sync_play_set_ignore_wait(ignore_wait_request_dto)
Request SyncPlay group to ignore member during group-wait.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.ignore_wait_request_dto import IgnoreWaitRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
ignore_wait_request_dto = jellyfin.generated.api_10_11.IgnoreWaitRequestDto() # IgnoreWaitRequestDto | The settings to set.
try:
# Request SyncPlay group to ignore member during group-wait.
api_instance.sync_play_set_ignore_wait(ignore_wait_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_set_ignore_wait: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ignore_wait_request_dto | IgnoreWaitRequestDto | The settings to set. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Member state updated. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_set_new_queue
sync_play_set_new_queue(play_request_dto)
Request to set new playlist in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.play_request_dto import PlayRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
play_request_dto = jellyfin.generated.api_10_11.PlayRequestDto() # PlayRequestDto | The new playlist to play in the group.
try:
# Request to set new playlist in SyncPlay group.
api_instance.sync_play_set_new_queue(play_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_set_new_queue: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| play_request_dto | PlayRequestDto | The new playlist to play in the group. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Queue update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_set_playlist_item
sync_play_set_playlist_item(set_playlist_item_request_dto)
Request to change playlist item in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.set_playlist_item_request_dto import SetPlaylistItemRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
set_playlist_item_request_dto = jellyfin.generated.api_10_11.SetPlaylistItemRequestDto() # SetPlaylistItemRequestDto | The new item to play.
try:
# Request to change playlist item in SyncPlay group.
api_instance.sync_play_set_playlist_item(set_playlist_item_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_set_playlist_item: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| set_playlist_item_request_dto | SetPlaylistItemRequestDto | The new item to play. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Queue update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_set_repeat_mode
sync_play_set_repeat_mode(set_repeat_mode_request_dto)
Request to set repeat mode in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.set_repeat_mode_request_dto import SetRepeatModeRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
set_repeat_mode_request_dto = jellyfin.generated.api_10_11.SetRepeatModeRequestDto() # SetRepeatModeRequestDto | The new repeat mode.
try:
# Request to set repeat mode in SyncPlay group.
api_instance.sync_play_set_repeat_mode(set_repeat_mode_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_set_repeat_mode: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| set_repeat_mode_request_dto | SetRepeatModeRequestDto | The new repeat mode. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Play queue update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_set_shuffle_mode
sync_play_set_shuffle_mode(set_shuffle_mode_request_dto)
Request to set shuffle mode in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.set_shuffle_mode_request_dto import SetShuffleModeRequestDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
set_shuffle_mode_request_dto = jellyfin.generated.api_10_11.SetShuffleModeRequestDto() # SetShuffleModeRequestDto | The new shuffle mode.
try:
# Request to set shuffle mode in SyncPlay group.
api_instance.sync_play_set_shuffle_mode(set_shuffle_mode_request_dto)
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_set_shuffle_mode: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| set_shuffle_mode_request_dto | SetShuffleModeRequestDto | The new shuffle mode. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Play queue update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_stop
sync_play_stop()
Request stop in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
try:
# Request stop in SyncPlay group.
api_instance.sync_play_stop()
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_stop: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Stop update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sync_play_unpause
sync_play_unpause()
Request unpause in SyncPlay group.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.SyncPlayApi(api_client)
try:
# Request unpause in SyncPlay group.
api_instance.sync_play_unpause()
except Exception as e:
print("Exception when calling SyncPlayApi->sync_play_unpause: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Unpause update sent to all group members. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]