Package video.api.client.api.models

Class WebhooksCreationPayload

java.lang.Object

video.api.client.api.models.WebhooksCreationPayload

All Implemented Interfaces:

Serializable

public class WebhooksCreationPayload
extends Object
implements Serializable

WebhooksCreationPayload

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_EVENTS
static String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor	Description
WebhooksCreationPayload()

Method Summary

Modifier and Type	Method	Description
WebhooksCreationPayload	addEventsItem(String eventsItem)
boolean	equals(Object o)
WebhooksCreationPayload	events(List<String> events)
List<String>	getEvents()	A list of the webhooks that you are subscribing to.
String	getUrl()	The the url to which HTTP notifications are sent.
int	hashCode()
void	setEvents(List<String> events)
void	setUrl(String url)
String	toString()
WebhooksCreationPayload	url(String url)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_EVENTS

public static final String SERIALIZED_NAME_EVENTS

See Also:

Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

Constant Field Values

Constructor Detail

WebhooksCreationPayload

public WebhooksCreationPayload()

Method Detail

events

public WebhooksCreationPayload events(List<String> events)

addEventsItem

public WebhooksCreationPayload addEventsItem(String eventsItem)

getEvents

public List<String> getEvents()

A list of the webhooks that you are subscribing to. There are Currently four webhook options: * ```video.encoding.quality.completed``` When a new video is uploaded into your account, it will be encoded into several different HLS sizes/bitrates. When each version is encoded, your webhook will get a notification. It will look like ```{ \\\"type\\\": \\\"video.encoding.quality.completed\\\", \\\"emittedAt\\\": \\\"2021-01-29T16:46:25.217+01:00\\\", \\\"videoId\\\": \\\"viXXXXXXXX\\\", \\\"encoding\\\": \\\"hls\\\", \\\"quality\\\": \\\"720p\\\"} ```. This request says that the 720p HLS encoding was completed. * ```live-stream.broadcast.started``` When a livestream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires. * ```live-stream.broadcast.ended``` This event fores when the livestream has finished broadcasting, and the broadcasting parameter flips from false to true. * ```video.source.recorded``` This event is similar to ```video.encoding.quality.completed```, but tells you if a livestream has been recorded as a VOD.

Returns:

events

setEvents

public void setEvents(List<String> events)

url

public WebhooksCreationPayload url(String url)

getUrl

public String getUrl()

The the url to which HTTP notifications are sent. It could be any http or https URL.

Returns:

url

setUrl

public void setUrl(String url)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object