sync-play.md

Sync Play

sync_play_controller = client.sync_play

Class Name

SyncPlayController

Methods

• Sync Play Buffering
• Sync Play Create Group
• Sync Play Get Groups
• Sync Play Join Group
• Sync Play Leave Group
• Sync Play Move Playlist Item
• Sync Play Next Item
• Sync Play Pause
• Sync Play Ping
• Sync Play Previous Item
• Sync Play Queue
• Sync Play Ready
• Sync Play Remove From Playlist
• Sync Play Seek
• Sync Play Set Ignore Wait
• Sync Play Set New Queue
• Sync Play Set Playlist Item
• Sync Play Set Repeat Mode
• Sync Play Set Shuffle Mode
• Sync Play Stop
• Sync Play Unpause

Sync Play Buffering

Notify SyncPlay group that member is buffering.

def sync_play_buffering(self,
                       body)

Parameters

Parameter	Type	Tags	Description
body	BufferRequestDto	Body, Required	The player status.

Response Type

void

Example Usage

body = BufferRequestDto()

result = sync_play_controller.sync_play_buffering(body)

Errors

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

Sync Play Create Group

Create a new SyncPlay group.

def sync_play_create_group(self,
                          body)

Parameters

Parameter	Type	Tags	Description
body	NewGroupRequestDto	Body, Required	The settings of the new group.

Response Type

void

Example Usage

body = NewGroupRequestDto()

result = sync_play_controller.sync_play_create_group(body)

Errors

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

Sync Play Get Groups

Gets all SyncPlay groups.

def sync_play_get_groups(self)

Response Type

List of GroupInfoDto

Example Usage

result = sync_play_controller.sync_play_get_groups()

Errors

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

Sync Play Join Group

Join an existing SyncPlay group.

def sync_play_join_group(self,
                        body)

Parameters

Parameter	Type	Tags	Description
body	JoinGroupRequestDto	Body, Required	The group to join.

Response Type

void

Example Usage

body = JoinGroupRequestDto()

result = sync_play_controller.sync_play_join_group(body)

Errors

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

Sync Play Leave Group

Leave the joined SyncPlay group.

def sync_play_leave_group(self)

Response Type

void

Example Usage

result = sync_play_controller.sync_play_leave_group()

Errors

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

Sync Play Move Playlist Item

Request to move an item in the playlist in SyncPlay group.

def sync_play_move_playlist_item(self,
                                body)

Parameters

Parameter	Type	Tags	Description
body	MovePlaylistItemRequestDto	Body, Required	The new position for the item.

Response Type

void

Example Usage

body = MovePlaylistItemRequestDto()

result = sync_play_controller.sync_play_move_playlist_item(body)

Errors

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

Sync Play Next Item

Request next item in SyncPlay group.

def sync_play_next_item(self,
                       body)

Parameters

Parameter	Type	Tags	Description
body	NextItemRequestDto	Body, Required	The current item information.

Response Type

void

Example Usage

body = NextItemRequestDto()

result = sync_play_controller.sync_play_next_item(body)

Errors

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

Sync Play Pause

Request pause in SyncPlay group.

def sync_play_pause(self)

Response Type

void

Example Usage

result = sync_play_controller.sync_play_pause()

Errors

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

Sync Play Ping

Update session ping.

def sync_play_ping(self,
                  body)

Parameters

Parameter	Type	Tags	Description
body	PingRequestDto	Body, Required	The new ping.

Response Type

void

Example Usage

body = PingRequestDto()

result = sync_play_controller.sync_play_ping(body)

Errors

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

Sync Play Previous Item

Request previous item in SyncPlay group.

def sync_play_previous_item(self,
                           body)

Parameters

Parameter	Type	Tags	Description
body	PreviousItemRequestDto	Body, Required	The current item information.

Response Type

void

Example Usage

body = PreviousItemRequestDto()

result = sync_play_controller.sync_play_previous_item(body)

Errors

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

Sync Play Queue

Request to queue items to the playlist of a SyncPlay group.

def sync_play_queue(self,
                   body)

Parameters

Parameter	Type	Tags	Description
body	QueueRequestDto	Body, Required	The items to add.

Response Type

void

Example Usage

body = QueueRequestDto()

result = sync_play_controller.sync_play_queue(body)

Errors

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

Sync Play Ready

Notify SyncPlay group that member is ready for playback.

def sync_play_ready(self,
                   body)

Parameters

Parameter	Type	Tags	Description
body	ReadyRequestDto	Body, Required	The player status.

Response Type

void

Example Usage

body = ReadyRequestDto()

result = sync_play_controller.sync_play_ready(body)

Errors

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

Sync Play Remove From Playlist

Request to remove items from the playlist in SyncPlay group.

def sync_play_remove_from_playlist(self,
                                  body)

Parameters

Parameter	Type	Tags	Description
body	RemoveFromPlaylistRequestDto	Body, Required	The items to remove.

Response Type

void

Example Usage

body = RemoveFromPlaylistRequestDto()

result = sync_play_controller.sync_play_remove_from_playlist(body)

Errors

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

Sync Play Seek

Request seek in SyncPlay group.

def sync_play_seek(self,
                  body)

Parameters

Parameter	Type	Tags	Description
body	SeekRequestDto	Body, Required	The new playback position.

Response Type

void

Example Usage

body = SeekRequestDto()

result = sync_play_controller.sync_play_seek(body)

Errors

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

Sync Play Set Ignore Wait

Request SyncPlay group to ignore member during group-wait.

def sync_play_set_ignore_wait(self,
                             body)

Parameters

Parameter	Type	Tags	Description
body	IgnoreWaitRequestDto	Body, Required	The settings to set.

Response Type

void

Example Usage

body = IgnoreWaitRequestDto()

result = sync_play_controller.sync_play_set_ignore_wait(body)

Errors

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

Sync Play Set New Queue

Request to set new playlist in SyncPlay group.

def sync_play_set_new_queue(self,
                           body)

Parameters

Parameter	Type	Tags	Description
body	PlayRequestDto	Body, Required	The new playlist to play in the group.

Response Type

void

Example Usage

body = PlayRequestDto()

result = sync_play_controller.sync_play_set_new_queue(body)

Errors

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

Sync Play Set Playlist Item

Request to change playlist item in SyncPlay group.

def sync_play_set_playlist_item(self,
                               body)

Parameters

Parameter	Type	Tags	Description
body	SetPlaylistItemRequestDto	Body, Required	The new item to play.

Response Type

void

Example Usage

body = SetPlaylistItemRequestDto()

result = sync_play_controller.sync_play_set_playlist_item(body)

Errors

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

Sync Play Set Repeat Mode

Request to set repeat mode in SyncPlay group.

def sync_play_set_repeat_mode(self,
                             body)

Parameters

Parameter	Type	Tags	Description
body	SetRepeatModeRequestDto	Body, Required	The new repeat mode.

Response Type

void

Example Usage

body = SetRepeatModeRequestDto()

result = sync_play_controller.sync_play_set_repeat_mode(body)

Errors

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

Sync Play Set Shuffle Mode

Request to set shuffle mode in SyncPlay group.

def sync_play_set_shuffle_mode(self,
                              body)

Parameters

Parameter	Type	Tags	Description
body	SetShuffleModeRequestDto	Body, Required	The new shuffle mode.

Response Type

void

Example Usage

body = SetShuffleModeRequestDto()

result = sync_play_controller.sync_play_set_shuffle_mode(body)

Errors

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

Sync Play Stop

Request stop in SyncPlay group.

def sync_play_stop(self)

Response Type

void

Example Usage

result = sync_play_controller.sync_play_stop()

Errors

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

Sync Play Unpause

Request unpause in SyncPlay group.

def sync_play_unpause(self)

Response Type

void

Example Usage

result = sync_play_controller.sync_play_unpause()

Errors

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