public class CompositionCreator extends Creator<Composition>
Constructor and Description |
---|
CompositionCreator(String roomSid)
Construct a new CompositionCreator.
|
Modifier and Type | Method and Description |
---|---|
Composition |
create(TwilioRestClient client)
Make the request to the Twilio API to perform the create.
|
CompositionCreator |
setAudioSources(List<String> audioSources)
An array of track names from the same group room to merge into the new
composition.
|
CompositionCreator |
setAudioSources(String audioSources)
An array of track names from the same group room to merge into the new
composition.
|
CompositionCreator |
setAudioSourcesExcluded(List<String> audioSourcesExcluded)
An array of track names to exclude.
|
CompositionCreator |
setAudioSourcesExcluded(String audioSourcesExcluded)
An array of track names to exclude.
|
CompositionCreator |
setFormat(Composition.Format format)
The container format of the composition's media files.
|
CompositionCreator |
setResolution(String resolution)
A string that describes the columns (width) and rows (height) of the
generated composed video in pixels.
|
CompositionCreator |
setStatusCallback(String statusCallback)
The URL we should call using the `status_callback_method` to send status
information to your application on every composition event.
|
CompositionCreator |
setStatusCallback(URI statusCallback)
The URL we should call using the `status_callback_method` to send status
information to your application on every composition event.
|
CompositionCreator |
setStatusCallbackMethod(HttpMethod statusCallbackMethod)
The HTTP method we should use to call `status_callback`.
|
CompositionCreator |
setTrim(Boolean trim)
Whether to clip the intervals where there is no active media in the
composition.
|
CompositionCreator |
setVideoLayout(Map<String,Object> videoLayout)
An object that describes the video layout of the composition in terms of
regions.
|
create, createAsync, createAsync
public CompositionCreator(String roomSid)
roomSid
- The SID of the Group Room with the media tracks to be used as
composition sourcespublic CompositionCreator setVideoLayout(Map<String,Object> videoLayout)
videoLayout
- An object that describes the video layout of the
compositionpublic CompositionCreator setAudioSources(List<String> audioSources)
audioSources
- An array of track names from the same group room to mergepublic CompositionCreator setAudioSources(String audioSources)
audioSources
- An array of track names from the same group room to mergepublic CompositionCreator setAudioSourcesExcluded(List<String> audioSourcesExcluded)
audioSourcesExcluded
- An array of track names to excludepublic CompositionCreator setAudioSourcesExcluded(String audioSourcesExcluded)
audioSourcesExcluded
- An array of track names to excludepublic CompositionCreator setResolution(String resolution)
resolution
- A string that describes the columns (width) and rows
(height) of the generated composed video in pixelspublic CompositionCreator setFormat(Composition.Format format)
format
- The container format of the composition's media filespublic CompositionCreator setStatusCallback(URI statusCallback)
statusCallback
- The URL we should call to send status information to
your applicationpublic CompositionCreator setStatusCallback(String statusCallback)
statusCallback
- The URL we should call to send status information to
your applicationpublic CompositionCreator setStatusCallbackMethod(HttpMethod statusCallbackMethod)
statusCallbackMethod
- The HTTP method we should use to call
status_callbackpublic CompositionCreator setTrim(Boolean trim)
trim
- Whether to clip the intervals where there is no active media in
the compositionpublic Composition create(TwilioRestClient client)
create
in class Creator<Composition>
client
- TwilioRestClient with which to make the requestCopyright © 2019 Twilio, Inc. All Rights Reserved.