Sign in
VideoV1Composition

Returns a single Composition resource identified by a Composition SID.

Returns a single Composition resource identified by a Composition SID.

get/v1/Compositions/{Sid}

Path parameters

Sidstring required

The SID of the Composition resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the Composition resource.

status'enqueued' | 'processing' | 'completed' | 'deleted' | 'failed'

The status of the composition. Can be: enqueued, processing, completed, deleted or failed. enqueued is the initial state and indicates that the composition request has been received and is scheduled for processing; processing indicates the composition is being processed; completed indicates the composition has been completed and is available for download; deleted means the composition media has been deleted from the system, but its metadata is still available for 30 days; failed indicates the composition failed to execute the media processing task.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_completedstring date-time nullable

The date and time in GMT when the composition's media processing task finished, specified in ISO 8601 format.

date_deletedstring date-time nullable

The date and time in GMT when the composition generated media was deleted, specified in ISO 8601 format.

sidstring nullable

The unique string that we created to identify the Composition resource.

room_sidstring nullable

The SID of the Group Room that generated the audio and video tracks used in the composition. All media sources included in a composition must belong to the same Group Room.

audio_sourcesstring[] nullable

The array of track names to include in the composition. The composition includes all audio sources specified in audio_sources except those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* includes tracks named student as well as studentTeam.

audio_sources_excludedstring[] nullable

The array of track names to exclude from the composition. The composition includes all audio sources specified in audio_sources except for those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* excludes student as well as studentTeam. This parameter can also be empty.

{"stackTrail":"components:schemas:video.v1.composition:properties:video_layout","oasType":"schema","type":"unknown","description":"An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.","extensionFields":{"x-twilio":{"pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
resolutionstring nullable

The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string's format is {width}x{height}, such as 640x480.

trimboolean nullable

Whether to remove intervals with no media, as specified in the POST request that created the composition. Compositions with trim enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See Specifying Video Layouts for more info.

format'mp4' | 'webm'

The container format of the composition's media files as specified in the POST request that created the Composition resource. See POST Parameters for more information.

bitrateinteger

The average bit rate of the composition's media.

sizeinteger nullable

The size of the composed media file in bytes.

durationinteger

The duration of the composition's media file in seconds.

media_external_locationstring uri nullable

The URL of the media file associated with the composition when stored externally. See External S3 Compositions for more details.

status_callbackstring uri nullable

The URL called using the status_callback_method to send status information on every composition event.

status_callback_method'GET' | 'POST' http-method nullable

The HTTP method used to call status_callback. Can be: POST or GET, defaults to POST.

urlstring uri nullable

The absolute URL of the resource.

linksobject nullable

The URL of the media file associated with the composition.

Changes

Changed in 5 of the 50 revisions of this API.27

  • v1207f8ef612391See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

  • v1ad992ed01a681See the full diff
    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

  • v1d1c4c2eb9f232See the full diff
    • ○

      the response's property default value 0 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 0 was added for the status

      response-property-default-value-added

  • v1d68da44b72424See the full diff
    • ○

      removed the DELETE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the response property for the response status

      response-property-enum-value-removed

  • v1987a2e6965981See the full diff
    • ○

      api tag VideoV1Composition added

      api-tag-added