com.bitmovin.api.sdk.streams.video

Class VideoApi

java.lang.Object

com.bitmovin.api.sdk.streams.video.VideoApi

public class VideoApi
extends Object

Constructor Summary

Constructors

Constructor and Description
VideoApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<VideoApi>	builder() Fluent builder for creating an instance of VideoApi
StreamsVideoResponse	create(StreamsVideoCreateRequest streamsVideoCreateRequest) Create new Streams video
void	delete(String streamId) Delete Stream
StreamsVideoResponse	get(String streamId) Get Streams video by id
PaginationResponse<StreamsVideoResponse>	list() Get paginated list of Streams videos
PaginationResponse<StreamsVideoResponse>	list(StreamsVideoResponseListQueryParams queryParams) Get paginated list of Streams videos
StreamsVideoResponse	patchStreamsVideo(String streamId, StreamsVideoUpdateRequest streamsVideoUpdateRequest) Partially update video stream by id

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoApi

public VideoApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<VideoApi> builder()

Fluent builder for creating an instance of VideoApi

create

public StreamsVideoResponse create(StreamsVideoCreateRequest streamsVideoCreateRequest)
                            throws BitmovinException

Create new Streams video

Parameters:

streamsVideoCreateRequest - Create a new stream. (required)

Returns:

StreamsVideoResponse

Throws:

BitmovinException - if fails to make API call

delete

public void delete(String streamId)
            throws BitmovinException

Delete Stream

Parameters:

streamId - Id of the stream. (required)

Throws:

BitmovinException - if fails to make API call

get

public StreamsVideoResponse get(String streamId)
                         throws BitmovinException

Get Streams video by id

Parameters:

streamId - Id of the stream. (required)

Returns:

StreamsVideoResponse

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<StreamsVideoResponse> list()
                                              throws BitmovinException

Get paginated list of Streams videos

Returns:

List<StreamsVideoResponse>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<StreamsVideoResponse> list(StreamsVideoResponseListQueryParams queryParams)
                                              throws BitmovinException

Get paginated list of Streams videos

Parameters:

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<StreamsVideoResponse>

Throws:

BitmovinException - if fails to make API call

patchStreamsVideo

public StreamsVideoResponse patchStreamsVideo(String streamId,
                                              StreamsVideoUpdateRequest streamsVideoUpdateRequest)
                                       throws BitmovinException

Partially update video stream by id

Parameters:

streamId - Id of the stream. (required)

streamsVideoUpdateRequest - Stream fields to update. (required)

Returns:

StreamsVideoResponse

Throws:

BitmovinException - if fails to make API call