github.com/twilio/twilio-go@v1.20.1/rest/video/v1/model_video_v1_composition_hook.go (about)

     1  /*
     2   * This code was generated by
     3   * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
     4   *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
     5   *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
     6   *
     7   * Twilio - Video
     8   * This is the public Twilio REST API.
     9   *
    10   * NOTE: This class is auto generated by OpenAPI Generator.
    11   * https://openapi-generator.tech
    12   * Do not edit the class manually.
    13   */
    14  
    15  package openapi
    16  
    17  import (
    18  	"time"
    19  )
    20  
    21  // VideoV1CompositionHook struct for VideoV1CompositionHook
    22  type VideoV1CompositionHook struct {
    23  	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CompositionHook resource.
    24  	AccountSid *string `json:"account_sid,omitempty"`
    25  	// The string that you assigned to describe the resource. Can be up to 100 characters long and must be unique within the account.
    26  	FriendlyName *string `json:"friendly_name,omitempty"`
    27  	// Whether the CompositionHook is active. When `true`, the CompositionHook is triggered for every completed Group Room on the account. When `false`, the CompositionHook is never triggered.
    28  	Enabled *bool `json:"enabled,omitempty"`
    29  	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    30  	DateCreated *time.Time `json:"date_created,omitempty"`
    31  	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    32  	DateUpdated *time.Time `json:"date_updated,omitempty"`
    33  	// The unique string that we created to identify the CompositionHook resource.
    34  	Sid *string `json:"sid,omitempty"`
    35  	// The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook 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`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request
    36  	AudioSources *[]string `json:"audio_sources,omitempty"`
    37  	// The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook 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.
    38  	AudioSourcesExcluded *[]string `json:"audio_sources_excluded,omitempty"`
    39  	// A JSON object that describes the video layout of the composition in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request
    40  	VideoLayout *interface{} `json:"video_layout,omitempty"`
    41  	// 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`.
    42  	Resolution *string `json:"resolution,omitempty"`
    43  	// Whether intervals with no media are clipped, as specified in the POST request that created the CompositionHook resource. 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](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
    44  	Trim   *bool   `json:"trim,omitempty"`
    45  	Format *string `json:"format,omitempty"`
    46  	// The URL we call using the `status_callback_method` to send status information to your application.
    47  	StatusCallback *string `json:"status_callback,omitempty"`
    48  	// The HTTP method we should use to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`.
    49  	StatusCallbackMethod *string `json:"status_callback_method,omitempty"`
    50  	// The absolute URL of the resource.
    51  	Url *string `json:"url,omitempty"`
    52  }