CompositionHook (Twilio Java)

java.lang.Object
- com.twilio.base.Resource
- - com.twilio.rest.video.v1.CompositionHook

All Implemented Interfaces:

Serializable
```
public class CompositionHook
extends Resource
```
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CompositionHook.Format

Nested Classes
Modifier and Type	Class and Description
`static class`	`CompositionHook.Format`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CompositionHookCreator`	`creator(String friendlyName)` Create a CompositionHookCreator to execute create.
`static CompositionHookDeleter`	`deleter(String pathSid)` Create a CompositionHookDeleter to execute delete.
`boolean`	`equals(Object o)`
`static CompositionHookFetcher`	`fetcher(String pathSid)` Create a CompositionHookFetcher to execute fetch.
`static CompositionHook`	`fromJson(InputStream json, com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Converts a JSON InputStream into a CompositionHook object using the provided ObjectMapper.
`static CompositionHook`	`fromJson(String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Converts a JSON String into a CompositionHook object using the provided ObjectMapper.
`String`	`getAccountSid()` Returns The SID of the Account that created the resource.
`List<String>`	`getAudioSources()` Returns The array of track names to include in the compositions created by the composition hook.
`List<String>`	`getAudioSourcesExcluded()` Returns The array of track names to exclude from the compositions created by the composition hook.
`ZonedDateTime`	`getDateCreated()` Returns The ISO 8601 date and time in GMT when the resource was created.
`ZonedDateTime`	`getDateUpdated()` Returns The ISO 8601 date and time in GMT when the resource was last updated.
`Boolean`	`getEnabled()` Returns Whether the CompositionHook is active.
`CompositionHook.Format`	`getFormat()` Returns The container format of the media files used by the compositions created by the composition hook.
`String`	`getFriendlyName()` Returns The string that you assigned to describe the resource.
`String`	`getResolution()` Returns The dimensions of the video image in pixels expressed as columns (width) and rows (height).
`String`	`getSid()` Returns The unique string that identifies the resource.
`URI`	`getStatusCallback()` Returns The URL to send status information to your application.
`HttpMethod`	`getStatusCallbackMethod()` Returns The HTTP method we should use to call status_callback.
`Boolean`	`getTrim()` Returns Whether intervals with no media are clipped.
`URI`	`getUrl()` Returns The absolute URL of the resource.
`Map<String,Object>`	`getVideoLayout()` Returns A JSON object that describes the video layout of the Composition.
`int`	`hashCode()`
`static CompositionHookReader`	`reader()` Create a CompositionHookReader to execute read.
`static CompositionHookUpdater`	`updater(String pathSid, String friendlyName)` Create a CompositionHookUpdater to execute update.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - fetcher
```
public static CompositionHookFetcher fetcher(String pathSid)
```
    Create a CompositionHookFetcher to execute fetch.
    
    Parameters:
    
    pathSid - The SID that identifies the resource to fetch
    
    Returns:
    
    CompositionHookFetcher capable of executing the fetch
  - reader
```
public static CompositionHookReader reader()
```
    Create a CompositionHookReader to execute read.
    
    Returns:
    
    CompositionHookReader capable of executing the read
  - deleter
```
public static CompositionHookDeleter deleter(String pathSid)
```
    Create a CompositionHookDeleter to execute delete.
    
    Parameters:
    
    pathSid - The SID that identifies the resource to delete
    
    Returns:
    
    CompositionHookDeleter capable of executing the delete
  - creator
```
public static CompositionHookCreator creator(String friendlyName)
```
    Create a CompositionHookCreator to execute create.
    
    Parameters:
    
    friendlyName - A unique string to describe the resource
    
    Returns:
    
    CompositionHookCreator capable of executing the create
  - updater
```
public static CompositionHookUpdater updater(String pathSid,
                                             String friendlyName)
```
    Create a CompositionHookUpdater to execute update.
    
    Parameters:
    
    pathSid - The SID that identifies the resource to update
    
    friendlyName - A unique string to describe the resource
    
    Returns:
    
    CompositionHookUpdater capable of executing the update
  - fromJson
```
public static CompositionHook fromJson(String json,
                                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Converts a JSON String into a CompositionHook object using the provided ObjectMapper.
    
    Parameters:
    
    json - Raw JSON String
    
    objectMapper - Jackson ObjectMapper
    
    Returns:
    
    CompositionHook object represented by the provided JSON
  - fromJson
```
public static CompositionHook fromJson(InputStream json,
                                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Converts a JSON InputStream into a CompositionHook object using the provided ObjectMapper.
    
    Parameters:
    
    json - Raw JSON InputStream
    
    objectMapper - Jackson ObjectMapper
    
    Returns:
    
    CompositionHook object represented by the provided JSON
  - getAccountSid
```
public final String getAccountSid()
```
    Returns The SID of the Account that created the resource.
    
    Returns:
    
    The SID of the Account that created the resource
  - getFriendlyName
```
public final String getFriendlyName()
```
    Returns The string that you assigned to describe the resource.
    
    Returns:
    
    The string that you assigned to describe the resource
  - getEnabled
```
public final Boolean getEnabled()
```
    Returns Whether the CompositionHook is active.
    
    Returns:
    
    Whether the CompositionHook is active
  - getDateCreated
```
public final ZonedDateTime getDateCreated()
```
    Returns The ISO 8601 date and time in GMT when the resource was created.
    
    Returns:
    
    The ISO 8601 date and time in GMT when the resource was created
  - getDateUpdated
```
public final ZonedDateTime getDateUpdated()
```
    Returns The ISO 8601 date and time in GMT when the resource was last updated.
    
    Returns:
    
    The ISO 8601 date and time in GMT when the resource was last updated
  - getSid
```
public final String getSid()
```
    Returns The unique string that identifies the resource.
    
    Returns:
    
    The unique string that identifies the resource
  - getAudioSources
```
public final List<String> getAudioSources()
```
    Returns The array of track names to include in the compositions created by the composition hook.
    
    Returns:
    
    The array of track names to include in the compositions created by the composition hook
  - getAudioSourcesExcluded
```
public final List<String> getAudioSourcesExcluded()
```
    Returns The array of track names to exclude from the compositions created by the composition hook.
    
    Returns:
    
    The array of track names to exclude from the compositions created by the composition hook
  - getVideoLayout
```
public final Map<String,Object> getVideoLayout()
```
    Returns A JSON object that describes the video layout of the Composition.
    
    Returns:
    
    A JSON object that describes the video layout of the Composition
  - getResolution
```
public final String getResolution()
```
    Returns The dimensions of the video image in pixels expressed as columns (width) and rows (height).
    
    Returns:
    
    The dimensions of the video image in pixels expressed as columns (width) and rows (height)
  - getTrim
```
public final Boolean getTrim()
```
    Returns Whether intervals with no media are clipped.
    
    Returns:
    
    Whether intervals with no media are clipped
  - getFormat
```
public final CompositionHook.Format getFormat()
```
    Returns The container format of the media files used by the compositions created by the composition hook.
    
    Returns:
    
    The container format of the media files used by the compositions created by the composition hook
  - getStatusCallback
```
public final URI getStatusCallback()
```
    Returns The URL to send status information to your application.
    
    Returns:
    
    The URL to send status information to your application
  - getStatusCallbackMethod
```
public final HttpMethod getStatusCallbackMethod()
```
    Returns The HTTP method we should use to call status_callback.
    
    Returns:
    
    The HTTP method we should use to call status_callback
  - getUrl
```
public final URI getUrl()
```
    Returns The absolute URL of the resource.
    
    Returns:
    
    The absolute URL of the resource
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class CompositionHook

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fetcher

reader

deleter

creator

updater

fromJson

fromJson

getAccountSid

getFriendlyName

getEnabled

getDateCreated

getDateUpdated

getSid

getAudioSources

getAudioSourcesExcluded

getVideoLayout

getResolution

getTrim

getFormat

getStatusCallback

getStatusCallbackMethod

getUrl

equals

hashCode