com.twilio.rest.video.v1

Class RoomCreator

java.lang.Object

com.twilio.base.Creator<Room>

com.twilio.rest.video.v1.RoomCreator

public class RoomCreator
extends Creator<Room>

Constructor Summary

Constructors

Constructor and Description
RoomCreator()

Method Summary

Modifier and Type	Method and Description
Room	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
RoomCreator	setEnableTurn(Boolean enableTurn) Deprecated, now always considered to be true..
RoomCreator	setMaxParticipants(Integer maxParticipants) The maximum number of concurrent Participants allowed in the room.
RoomCreator	setMediaRegion(String mediaRegion) The region for the media server in Group Rooms.
RoomCreator	setRecordParticipantsOnConnect(Boolean recordParticipantsOnConnect) Whether to start recording when Participants connect.
RoomCreator	setStatusCallback(String statusCallback) The URL we should call using the `status_callback_method` to send status information to your application on every room event.
RoomCreator	setStatusCallback(URI statusCallback) The URL we should call using the `status_callback_method` to send status information to your application on every room event.
RoomCreator	setStatusCallbackMethod(HttpMethod statusCallbackMethod) The HTTP method we should use to call `status_callback`.
RoomCreator	setType(Room.RoomType type) The type of room.
RoomCreator	setUniqueName(String uniqueName) An application-defined string that uniquely identifies the resource.
RoomCreator	setVideoCodecs(List<Room.VideoCodec> videoCodecs) An array of the video codecs that are supported when publishing a track in the room.
RoomCreator	setVideoCodecs(Room.VideoCodec videoCodecs) An array of the video codecs that are supported when publishing a track in the room.

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomCreator

public RoomCreator()

Method Detail

setEnableTurn

public RoomCreator setEnableTurn(Boolean enableTurn)

Deprecated, now always considered to be true..

Parameters:

enableTurn - Enable Twilio's Network Traversal TURN service

Returns:

this

setType

public RoomCreator setType(Room.RoomType type)

The type of room. Can be: `go`, `peer-to-peer`, `group-small`, or `group`. The default value is `group`..

Parameters:

type - The type of room

Returns:

this

setUniqueName

public RoomCreator setUniqueName(String uniqueName)

An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`..

Parameters:

uniqueName - An application-defined string that uniquely identifies the resource

Returns:

this

setStatusCallback

public RoomCreator setStatusCallback(URI statusCallback)

The URL we should call using the `status_callback_method` to send status information to your application on every room event. See Status Callbacks for more info..

Parameters:

statusCallback - The URL to send status information to your application

Returns:

this

setStatusCallback

public RoomCreator setStatusCallback(String statusCallback)

The URL we should call using the `status_callback_method` to send status information to your application on every room event. See Status Callbacks for more info..

Parameters:

statusCallback - The URL to send status information to your application

Returns:

this

setStatusCallbackMethod

public RoomCreator setStatusCallbackMethod(HttpMethod statusCallbackMethod)

The HTTP method we should use to call `status_callback`. Can be `POST` or `GET`..

Parameters:

statusCallbackMethod - The HTTP method we should use to call status_callback

Returns:

this

setMaxParticipants

public RoomCreator setMaxParticipants(Integer maxParticipants)

The maximum number of concurrent Participants allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small Group rooms can have up to 4 Participants. Group rooms can have up to 50 Participants..

Parameters:

maxParticipants - The maximum number of concurrent Participants allowed in the room

Returns:

this

setRecordParticipantsOnConnect

public RoomCreator setRecordParticipantsOnConnect(Boolean recordParticipantsOnConnect)

Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***.

Parameters:

recordParticipantsOnConnect - Whether to start recording when Participants connect

Returns:

this

setVideoCodecs

public RoomCreator setVideoCodecs(List<Room.VideoCodec> videoCodecs)

An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`. ***This feature is not available in `peer-to-peer` rooms***.

Parameters:

videoCodecs - An array of the video codecs that are supported when publishing a track in the room

Returns:

this

setVideoCodecs

public RoomCreator setVideoCodecs(Room.VideoCodec videoCodecs)

An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`. ***This feature is not available in `peer-to-peer` rooms***.

Parameters:

videoCodecs - An array of the video codecs that are supported when publishing a track in the room

Returns:

this

setMediaRegion

public RoomCreator setMediaRegion(String mediaRegion)

The region for the media server in Group Rooms. Can be: one of the available Media Regions. ***This feature is not available in `peer-to-peer` rooms.***.

Parameters:

mediaRegion - The region for the media server in Group Rooms

Returns:

this

create

public Room create(TwilioRestClient client)

Make the request to the Twilio API to perform the create.

Specified by:

create in class Creator<Room>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Room