composition

Documentation

Overview

Package composition contains auto-generated files. DO NOT MODIFY

Package composition contains auto-generated files. DO NOT MODIFY

Package composition contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchCompositionResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchCompositionResponse, error)
• type ClientProperties
• type FetchCompositionResponse

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for managing a specific composition resource See https://www.twilio.com/docs/video/api/compositions-resource for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the composition client

func (Client) Delete

func (c Client) Delete() error

Delete removes a composition resource from the account See https://www.twilio.com/docs/video/api/compositions-resource#delete-composition-http-delete for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a composition resource from the account See https://www.twilio.com/docs/video/api/compositions-resource#delete-composition-http-delete for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchCompositionResponse, error)

Fetch retrieves a composition resource See https://www.twilio.com/docs/video/api/compositions-resource#get-composition-http-get for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchCompositionResponse, error)

FetchWithContext retrieves a composition resource See https://www.twilio.com/docs/video/api/compositions-resource#get-composition-http-get for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the composition resources

type FetchCompositionResponse

type FetchCompositionResponse struct {
	AccountSid           string                 `json:"account_sid"`
	AudioSources         []string               `json:"audio_sources"`
	AudioSourcesExcluded []string               `json:"audio_sources_excluded"`
	Bitrate              int                    `json:"bitrate"`
	DateCompleted        *time.Time             `json:"date_completed,omitempty"`
	DateCreated          time.Time              `json:"date_created"`
	DateDeleted          *time.Time             `json:"date_deleted,omitempty"`
	Duration             int                    `json:"duration"`
	Format               string                 `json:"format"`
	Resolution           string                 `json:"resolution"`
	RoomSid              string                 `json:"room_sid"`
	Sid                  string                 `json:"sid"`
	Size                 int                    `json:"size"`
	Status               string                 `json:"status"`
	Trim                 bool                   `json:"trim"`
	URL                  string                 `json:"url"`
	VideoLayout          map[string]interface{} `json:"video_layout"`
}

FetchCompositionResponse defines the response fields for the retrieved composition