Interface PlaybackRetrofitAPI
public interface PlaybackRetrofitAPI
Interface for the channel playback retrofit based service
- Since:
- 1/13/14
-
Method Summary
Modifier and TypeMethodDescriptionvoid
startChannelPlayback
(PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) Retrofit method which requests a session to start a playbackvoid
startChannelPlaybackLegacy
(String session, PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) Retrofit method which requests a session to start a playbackvoid
startPrivateChannelPlayback
(PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) Retrofit method which requests a session to start a playbackretrofit.client.Response
stopChannelPlayback
(String deviceId, PlaybackRequest playback) Retrofit method which requests a session to stop its playback synchronouslyvoid
stopChannelPlayback
(String deviceId, PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) Retrofit method which requests a session to stop its playbackretrofit.client.Response
stopChannelPlaybackLegacy
(String session) Retrofit method which requests a session to stop its playback synchronouslyvoid
stopChannelPlaybackLegacy
(String session, retrofit.Callback<retrofit.client.Response> handler) Retrofit method which requests a session to stop its playbackretrofit.client.Response
stopChannelPlaybackv2
(String deviceId) Retrofit method which requests a session to stop its playback synchronouslyvoid
stopChannelPlaybackv2
(String deviceId, retrofit.Callback<retrofit.client.Response> handler) Retrofit method which requests a session to start a playback
-
Method Details
-
stopChannelPlayback
@POST("/exxtractor/api/v2/stream") void stopChannelPlayback(@Query("deviceId") String deviceId, @Body PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) throws retrofit.RetrofitError Retrofit method which requests a session to stop its playback- Throws:
retrofit.RetrofitError
-
stopChannelPlayback
@POST("/exxtractor/api/v2/stream") retrofit.client.Response stopChannelPlayback(@Query("deviceId") String deviceId, @Body PlaybackRequest playback) throws retrofit.RetrofitError Retrofit method which requests a session to stop its playback synchronously- Parameters:
deviceId
- The id for the current device, to identify the request origin- Returns:
- The HTTP response
- Throws:
retrofit.RetrofitError
-
startChannelPlayback
@POST("/exxtractor/api/v2/stream") void startChannelPlayback(@Body PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) throws retrofit.RetrofitError Retrofit method which requests a session to start a playback- Parameters:
playback
- The playback model with the audio stream definitionhandler
- The response handler- Throws:
retrofit.RetrofitError
-
stopChannelPlaybackv2
@DELETE("/exxtractor/api/v2/stream") retrofit.client.Response stopChannelPlaybackv2(@Query("deviceId") String deviceId) throws retrofit.RetrofitError Retrofit method which requests a session to stop its playback synchronously- Parameters:
deviceId
- The id for the current device, to identify the request origin- Returns:
- The HTTP response
- Throws:
retrofit.RetrofitError
-
stopChannelPlaybackv2
@DELETE("/exxtractor/api/v2/stream") void stopChannelPlaybackv2(@Query("deviceId") String deviceId, retrofit.Callback<retrofit.client.Response> handler) throws retrofit.RetrofitError Retrofit method which requests a session to start a playback- Parameters:
handler
- The response handler- Throws:
retrofit.RetrofitError
-
startPrivateChannelPlayback
@POST("/exxtractor/api/v3/privateStream") void startPrivateChannelPlayback(@Body PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) throws retrofit.RetrofitError Retrofit method which requests a session to start a playback- Parameters:
playback
- The playback model with the audio stream definitionhandler
- The response handler- Throws:
retrofit.RetrofitError
-
stopChannelPlaybackLegacy
@DELETE("/api/myapp/channels") void stopChannelPlaybackLegacy(@Query("session") String session, retrofit.Callback<retrofit.client.Response> handler) throws retrofit.RetrofitError Retrofit method which requests a session to stop its playback- Parameters:
session
- The current session for MyBox- Throws:
retrofit.RetrofitError
-
stopChannelPlaybackLegacy
@DELETE("/api/myapp/channels") retrofit.client.Response stopChannelPlaybackLegacy(@Query("session") String session) throws retrofit.RetrofitError Retrofit method which requests a session to stop its playback synchronously- Parameters:
session
- The current session for MyBox- Returns:
- The HTTP response
- Throws:
retrofit.RetrofitError
-
startChannelPlaybackLegacy
@POST("/api/myapp/channels") void startChannelPlaybackLegacy(@Query("session") String session, @Body PlaybackRequest playback, retrofit.Callback<retrofit.client.Response> handler) throws retrofit.RetrofitError Retrofit method which requests a session to start a playback- Parameters:
session
- The current session for MyBoxplayback
- The playback model with the audio stream definitionhandler
- The response handler- Throws:
retrofit.RetrofitError
-