Package video.api.client.api.clients

Class LiveStreamsApi

java.lang.Object

video.api.client.api.clients.LiveStreamsApi

public class LiveStreamsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LiveStreamsApi.APIlistRequest

Constructor Summary

Constructors

Constructor	Description
LiveStreamsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
LiveStream	create(LiveStreamCreationPayload liveStreamCreationPayload)	Create live stream A live stream will give you the 'connection point' to RTMP your video stream to api.video.
ApiResponse<LiveStream>	createWithHttpInfo(LiveStreamCreationPayload liveStreamCreationPayload)	Create live stream A live stream will give you the 'connection point' to RTMP your video stream to api.video.
void	delete(String liveStreamId)	Delete a live stream
LiveStream	deleteThumbnail(String liveStreamId)	Delete a thumbnail Send the unique identifier for a live stream to delete it from the system.
ApiResponse<LiveStream>	deleteThumbnailWithHttpInfo(String liveStreamId)	Delete a thumbnail Send the unique identifier for a live stream to delete it from the system.
ApiResponse<Void>	deleteWithHttpInfo(String liveStreamId)	Delete a live stream
LiveStream	get(String liveStreamId)	Show live stream Supply a LivestreamId, and you'll get all the details for streaming into, and watching the livestream.
ApiClient	getApiClient()
ApiResponse<LiveStream>	getWithHttpInfo(String liveStreamId)	Show live stream Supply a LivestreamId, and you'll get all the details for streaming into, and watching the livestream.
LiveStreamsApi.APIlistRequest	list()	List all live streams With no parameters added to the url, this will return all livestreams.
void	setApiClient(ApiClient apiClient)
LiveStream	update(String liveStreamId, LiveStreamUpdatePayload liveStreamUpdatePayload)	Update a live stream Use this endpoint to update the player, or to turn recording on/off (saving a copy of the livestream).
ApiResponse<LiveStream>	updateWithHttpInfo(String liveStreamId, LiveStreamUpdatePayload liveStreamUpdatePayload)	Update a live stream Use this endpoint to update the player, or to turn recording on/off (saving a copy of the livestream).
LiveStream	uploadThumbnail(String liveStreamId, File file)	Upload a thumbnail Upload an image to use as a backdrop for your livestream.
ApiResponse<LiveStream>	uploadThumbnailWithHttpInfo(String liveStreamId, File file)	Upload a thumbnail Upload an image to use as a backdrop for your livestream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LiveStreamsApi

public LiveStreamsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

delete

public void delete(String liveStreamId)
            throws ApiException

Delete a live stream

Parameters:

liveStreamId - The unique ID for the live stream that you want to remove. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-

deleteWithHttpInfo

public ApiResponse<Void> deleteWithHttpInfo(String liveStreamId)
                                     throws ApiException

Delete a live stream

Parameters:

liveStreamId - The unique ID for the live stream that you want to remove. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-

deleteThumbnail

public LiveStream deleteThumbnail(String liveStreamId)
                           throws ApiException

Delete a thumbnail Send the unique identifier for a live stream to delete it from the system.

Parameters:

liveStreamId - The unique identifier for the live stream you want to delete. (required)

Returns:

LiveStream

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
404	Not Found	-

deleteThumbnailWithHttpInfo

public ApiResponse<LiveStream> deleteThumbnailWithHttpInfo(String liveStreamId)
                                                    throws ApiException

Delete a thumbnail Send the unique identifier for a live stream to delete it from the system.

Parameters:

liveStreamId - The unique identifier for the live stream you want to delete. (required)

Returns:

ApiResponse<LiveStream>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
404	Not Found	-

list

public LiveStreamsApi.APIlistRequest list()

List all live streams With no parameters added to the url, this will return all livestreams. Query by name or key to limit the list.

Returns:

APIlistRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success	-

get

public LiveStream get(String liveStreamId)
               throws ApiException

Show live stream Supply a LivestreamId, and you'll get all the details for streaming into, and watching the livestream.

Parameters:

liveStreamId - The unique ID for the live stream you want to watch. (required)

Returns:

LiveStream

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-

getWithHttpInfo

public ApiResponse<LiveStream> getWithHttpInfo(String liveStreamId)
                                        throws ApiException

Show live stream Supply a LivestreamId, and you'll get all the details for streaming into, and watching the livestream.

Parameters:

liveStreamId - The unique ID for the live stream you want to watch. (required)

Returns:

ApiResponse<LiveStream>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-

update

public LiveStream update(String liveStreamId,
                         LiveStreamUpdatePayload liveStreamUpdatePayload)
                  throws ApiException

Update a live stream Use this endpoint to update the player, or to turn recording on/off (saving a copy of the livestream). NOTE: If the livestream is actively streaming, changing the recording status will only affect the NEXT stream. The public=false 'private livestream' is available as a BETA feature, and should be limited to livestreams of 3,000 viewers or fewer.

Parameters:

liveStreamId - The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off. (required)

liveStreamUpdatePayload - (required)

Returns:

LiveStream

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

updateWithHttpInfo

public ApiResponse<LiveStream> updateWithHttpInfo(String liveStreamId,
                                                  LiveStreamUpdatePayload liveStreamUpdatePayload)
                                           throws ApiException

Update a live stream Use this endpoint to update the player, or to turn recording on/off (saving a copy of the livestream). NOTE: If the livestream is actively streaming, changing the recording status will only affect the NEXT stream. The public=false 'private livestream' is available as a BETA feature, and should be limited to livestreams of 3,000 viewers or fewer.

Parameters:

liveStreamId - The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off. (required)

liveStreamUpdatePayload - (required)

Returns:

ApiResponse<LiveStream>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

create

public LiveStream create(LiveStreamCreationPayload liveStreamCreationPayload)
                  throws ApiException

Create live stream A live stream will give you the 'connection point' to RTMP your video stream to api.video. It will also give you the details for viewers to watch the same livestream. The public=false 'private livestream' is available as a BETA feature, and should be limited to livestreams of 3,000 viewers or fewer. See our [Live Stream Tutorial](https://api.video/blog/tutorials/live-stream-tutorial) for a walkthrough of this API with OBS. Your RTMP endpoint for the livestream is rtmp://broadcast.api.video/s/{streamKey}

Parameters:

liveStreamCreationPayload - (required)

Returns:

LiveStream

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

createWithHttpInfo

public ApiResponse<LiveStream> createWithHttpInfo(LiveStreamCreationPayload liveStreamCreationPayload)
                                           throws ApiException

Create live stream A live stream will give you the 'connection point' to RTMP your video stream to api.video. It will also give you the details for viewers to watch the same livestream. The public=false 'private livestream' is available as a BETA feature, and should be limited to livestreams of 3,000 viewers or fewer. See our [Live Stream Tutorial](https://api.video/blog/tutorials/live-stream-tutorial) for a walkthrough of this API with OBS. Your RTMP endpoint for the livestream is rtmp://broadcast.api.video/s/{streamKey}

Parameters:

liveStreamCreationPayload - (required)

Returns:

ApiResponse<LiveStream>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

uploadThumbnail

public LiveStream uploadThumbnail(String liveStreamId,
                                  File file)
                           throws ApiException

Upload a thumbnail Upload an image to use as a backdrop for your livestream.

Parameters:

liveStreamId - The unique ID for the live stream you want to upload. (required)

file - The image to be added as a thumbnail. (required)

Returns:

LiveStream

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
404	Not Found	-

uploadThumbnailWithHttpInfo

public ApiResponse<LiveStream> uploadThumbnailWithHttpInfo(String liveStreamId,
                                                           File file)
                                                    throws ApiException

Upload a thumbnail Upload an image to use as a backdrop for your livestream.

Parameters:

liveStreamId - The unique ID for the live stream you want to upload. (required)

file - The image to be added as a thumbnail. (required)

Returns:

ApiResponse<LiveStream>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
404	Not Found	-