Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Latest commit

 

History

History
939 lines (645 loc) · 31.3 KB

SyncPlayApi.md

File metadata and controls

939 lines (645 loc) · 31.3 KB

openapi.api.SyncPlayApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
syncPlayBuffering POST /SyncPlay/Buffering Notify SyncPlay group that member is buffering.
syncPlayCreateGroup POST /SyncPlay/New Create a new SyncPlay group.
syncPlayGetGroups GET /SyncPlay/List Gets all SyncPlay groups.
syncPlayJoinGroup POST /SyncPlay/Join Join an existing SyncPlay group.
syncPlayLeaveGroup POST /SyncPlay/Leave Leave the joined SyncPlay group.
syncPlayMovePlaylistItem POST /SyncPlay/MovePlaylistItem Request to move an item in the playlist in SyncPlay group.
syncPlayNextItem POST /SyncPlay/NextItem Request next item in SyncPlay group.
syncPlayPause POST /SyncPlay/Pause Request pause in SyncPlay group.
syncPlayPing POST /SyncPlay/Ping Update session ping.
syncPlayPreviousItem POST /SyncPlay/PreviousItem Request previous item in SyncPlay group.
syncPlayQueue POST /SyncPlay/Queue Request to queue items to the playlist of a SyncPlay group.
syncPlayReady POST /SyncPlay/Ready Notify SyncPlay group that member is ready for playback.
syncPlayRemoveFromPlaylist POST /SyncPlay/RemoveFromPlaylist Request to remove items from the playlist in SyncPlay group.
syncPlaySeek POST /SyncPlay/Seek Request seek in SyncPlay group.
syncPlaySetIgnoreWait POST /SyncPlay/SetIgnoreWait Request SyncPlay group to ignore member during group-wait.
syncPlaySetNewQueue POST /SyncPlay/SetNewQueue Request to set new playlist in SyncPlay group.
syncPlaySetPlaylistItem POST /SyncPlay/SetPlaylistItem Request to change playlist item in SyncPlay group.
syncPlaySetRepeatMode POST /SyncPlay/SetRepeatMode Request to set repeat mode in SyncPlay group.
syncPlaySetShuffleMode POST /SyncPlay/SetShuffleMode Request to set shuffle mode in SyncPlay group.
syncPlayStop POST /SyncPlay/Stop Request stop in SyncPlay group.
syncPlayUnpause POST /SyncPlay/Unpause Request unpause in SyncPlay group.

syncPlayBuffering

syncPlayBuffering(bufferRequestDto)

Notify SyncPlay group that member is buffering.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final BufferRequestDto bufferRequestDto = ; // BufferRequestDto | The player status.

try {
    api.syncPlayBuffering(bufferRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayBuffering: $e\n');
}

Parameters

Name Type Description Notes
bufferRequestDto BufferRequestDto The player status.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayCreateGroup

syncPlayCreateGroup(newGroupRequestDto)

Create a new SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final NewGroupRequestDto newGroupRequestDto = ; // NewGroupRequestDto | The settings of the new group.

try {
    api.syncPlayCreateGroup(newGroupRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayCreateGroup: $e\n');
}

Parameters

Name Type Description Notes
newGroupRequestDto NewGroupRequestDto The settings of the new group.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayGetGroups

BuiltList syncPlayGetGroups()

Gets all SyncPlay groups.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();

try {
    final response = api.syncPlayGetGroups();
    print(response);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayGetGroups: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

BuiltList<GroupInfoDto>

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

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

syncPlayJoinGroup

syncPlayJoinGroup(joinGroupRequestDto)

Join an existing SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final JoinGroupRequestDto joinGroupRequestDto = ; // JoinGroupRequestDto | The group to join.

try {
    api.syncPlayJoinGroup(joinGroupRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayJoinGroup: $e\n');
}

Parameters

Name Type Description Notes
joinGroupRequestDto JoinGroupRequestDto The group to join.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayLeaveGroup

syncPlayLeaveGroup()

Leave the joined SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();

try {
    api.syncPlayLeaveGroup();
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayLeaveGroup: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

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

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

syncPlayMovePlaylistItem

syncPlayMovePlaylistItem(movePlaylistItemRequestDto)

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

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final MovePlaylistItemRequestDto movePlaylistItemRequestDto = ; // MovePlaylistItemRequestDto | The new position for the item.

try {
    api.syncPlayMovePlaylistItem(movePlaylistItemRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayMovePlaylistItem: $e\n');
}

Parameters

Name Type Description Notes
movePlaylistItemRequestDto MovePlaylistItemRequestDto The new position for the item.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayNextItem

syncPlayNextItem(nextItemRequestDto)

Request next item in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final NextItemRequestDto nextItemRequestDto = ; // NextItemRequestDto | The current item information.

try {
    api.syncPlayNextItem(nextItemRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayNextItem: $e\n');
}

Parameters

Name Type Description Notes
nextItemRequestDto NextItemRequestDto The current item information.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayPause

syncPlayPause()

Request pause in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();

try {
    api.syncPlayPause();
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayPause: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

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

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

syncPlayPing

syncPlayPing(pingRequestDto)

Update session ping.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final PingRequestDto pingRequestDto = ; // PingRequestDto | The new ping.

try {
    api.syncPlayPing(pingRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayPing: $e\n');
}

Parameters

Name Type Description Notes
pingRequestDto PingRequestDto The new ping.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayPreviousItem

syncPlayPreviousItem(previousItemRequestDto)

Request previous item in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final PreviousItemRequestDto previousItemRequestDto = ; // PreviousItemRequestDto | The current item information.

try {
    api.syncPlayPreviousItem(previousItemRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayPreviousItem: $e\n');
}

Parameters

Name Type Description Notes
previousItemRequestDto PreviousItemRequestDto The current item information.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayQueue

syncPlayQueue(queueRequestDto)

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

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final QueueRequestDto queueRequestDto = ; // QueueRequestDto | The items to add.

try {
    api.syncPlayQueue(queueRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayQueue: $e\n');
}

Parameters

Name Type Description Notes
queueRequestDto QueueRequestDto The items to add.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayReady

syncPlayReady(readyRequestDto)

Notify SyncPlay group that member is ready for playback.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final ReadyRequestDto readyRequestDto = ; // ReadyRequestDto | The player status.

try {
    api.syncPlayReady(readyRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayReady: $e\n');
}

Parameters

Name Type Description Notes
readyRequestDto ReadyRequestDto The player status.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayRemoveFromPlaylist

syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto)

Request to remove items from the playlist in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final RemoveFromPlaylistRequestDto removeFromPlaylistRequestDto = ; // RemoveFromPlaylistRequestDto | The items to remove.

try {
    api.syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayRemoveFromPlaylist: $e\n');
}

Parameters

Name Type Description Notes
removeFromPlaylistRequestDto RemoveFromPlaylistRequestDto The items to remove.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlaySeek

syncPlaySeek(seekRequestDto)

Request seek in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final SeekRequestDto seekRequestDto = ; // SeekRequestDto | The new playback position.

try {
    api.syncPlaySeek(seekRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlaySeek: $e\n');
}

Parameters

Name Type Description Notes
seekRequestDto SeekRequestDto The new playback position.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlaySetIgnoreWait

syncPlaySetIgnoreWait(ignoreWaitRequestDto)

Request SyncPlay group to ignore member during group-wait.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final IgnoreWaitRequestDto ignoreWaitRequestDto = ; // IgnoreWaitRequestDto | The settings to set.

try {
    api.syncPlaySetIgnoreWait(ignoreWaitRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlaySetIgnoreWait: $e\n');
}

Parameters

Name Type Description Notes
ignoreWaitRequestDto IgnoreWaitRequestDto The settings to set.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlaySetNewQueue

syncPlaySetNewQueue(playRequestDto)

Request to set new playlist in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final PlayRequestDto playRequestDto = ; // PlayRequestDto | The new playlist to play in the group.

try {
    api.syncPlaySetNewQueue(playRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlaySetNewQueue: $e\n');
}

Parameters

Name Type Description Notes
playRequestDto PlayRequestDto The new playlist to play in the group.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlaySetPlaylistItem

syncPlaySetPlaylistItem(setPlaylistItemRequestDto)

Request to change playlist item in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final SetPlaylistItemRequestDto setPlaylistItemRequestDto = ; // SetPlaylistItemRequestDto | The new item to play.

try {
    api.syncPlaySetPlaylistItem(setPlaylistItemRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlaySetPlaylistItem: $e\n');
}

Parameters

Name Type Description Notes
setPlaylistItemRequestDto SetPlaylistItemRequestDto The new item to play.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlaySetRepeatMode

syncPlaySetRepeatMode(setRepeatModeRequestDto)

Request to set repeat mode in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final SetRepeatModeRequestDto setRepeatModeRequestDto = ; // SetRepeatModeRequestDto | The new repeat mode.

try {
    api.syncPlaySetRepeatMode(setRepeatModeRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlaySetRepeatMode: $e\n');
}

Parameters

Name Type Description Notes
setRepeatModeRequestDto SetRepeatModeRequestDto The new repeat mode.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlaySetShuffleMode

syncPlaySetShuffleMode(setShuffleModeRequestDto)

Request to set shuffle mode in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();
final SetShuffleModeRequestDto setShuffleModeRequestDto = ; // SetShuffleModeRequestDto | The new shuffle mode.

try {
    api.syncPlaySetShuffleMode(setShuffleModeRequestDto);
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlaySetShuffleMode: $e\n');
}

Parameters

Name Type Description Notes
setShuffleModeRequestDto SetShuffleModeRequestDto The new shuffle mode.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

syncPlayStop

syncPlayStop()

Request stop in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();

try {
    api.syncPlayStop();
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayStop: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

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

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

syncPlayUnpause

syncPlayUnpause()

Request unpause in SyncPlay group.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: CustomAuthentication
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('CustomAuthentication').apiKeyPrefix = 'Bearer';

final api = Openapi().getSyncPlayApi();

try {
    api.syncPlayUnpause();
} catch on DioException (e) {
    print('Exception when calling SyncPlayApi->syncPlayUnpause: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

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

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