composition_hook

Documentation

Overview

Package composition_hook contains auto-generated files. DO NOT MODIFY

Package composition_hook contains auto-generated files. DO NOT MODIFY

Package composition_hook contains auto-generated files. DO NOT MODIFY

Package composition_hook 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() (*FetchCompositionHookResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchCompositionHookResponse, error)
  • func (c Client) Update(input *UpdateCompositionHookInput) (*UpdateCompositionHookResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateCompositionHookInput) (*UpdateCompositionHookResponse, error)
• type ClientProperties
• type FetchCompositionHookResponse
• type UpdateCompositionHookInput
• type UpdateCompositionHookResponse

Types

type Client

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

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

func New

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

New creates a new instance of the composition hook client

func (Client) Delete

func (c Client) Delete() error

Delete removes a composition hook resource from the account See https://www.twilio.com/docs/video/api/composition-hooks#hk-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 hook resource from the account See https://www.twilio.com/docs/video/api/composition-hooks#hk-delete for more details

func (Client) Fetch

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

Fetch retrieves a composition hook resource See https://www.twilio.com/docs/video/api/composition-hooks#hk-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) (*FetchCompositionHookResponse, error)

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

func (Client) Update

func (c Client) Update(input *UpdateCompositionHookInput) (*UpdateCompositionHookResponse, error)

Update modifies a composition hook resource See https://www.twilio.com/docs/video/api/composition-hooks#hk-post for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateCompositionHookInput) (*UpdateCompositionHookResponse, error)

UpdateWithContext modifies a composition hook resource See https://www.twilio.com/docs/video/api/composition-hooks#hk-post for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the composition hook resources

type FetchCompositionHookResponse

type FetchCompositionHookResponse struct {
	AccountSid           string                 `json:"account_sid"`
	AudioSources         []string               `json:"audio_sources"`
	AudioSourcesExcluded []string               `json:"audio_sources_excluded"`
	DateCreated          time.Time              `json:"date_created"`
	DateUpdated          *time.Time             `json:"date_updated,omitempty"`
	Enabled              bool                   `json:"enabled"`
	Format               string                 `json:"format"`
	FriendlyName         string                 `json:"friendly_name"`
	Resolution           string                 `json:"resolution"`
	Sid                  string                 `json:"sid"`
	StatusCallback       *string                `json:"status_callback,omitempty"`
	StatusCallbackMethod string                 `json:"status_callback_method"`
	Trim                 bool                   `json:"trim"`
	URL                  string                 `json:"url"`
	VideoLayout          map[string]interface{} `json:"video_layout"`
}

FetchCompositionHookResponse defines the response fields for the retrieved composition hook

type UpdateCompositionHookInput

type UpdateCompositionHookInput struct {
	AudioSources         *[]string `form:"AudioSources,omitempty"`
	AudioSourcesExcluded *[]string `form:"AudioSourcesExcluded,omitempty"`
	Enabled              *bool     `form:"Enabled,omitempty"`
	Format               *string   `form:"Format,omitempty"`
	FriendlyName         string    `validate:"required" form:"FriendlyName"`
	Resolution           *string   `form:"Resolution,omitempty"`
	StatusCallback       *string   `form:"StatusCallback,omitempty"`
	StatusCallbackMethod *string   `form:"StatusCallbackMethod,omitempty"`
	Trim                 *bool     `form:"Trim,omitempty"`
	VideoLayout          *string   `form:"VideoLayout,omitempty"`
}

UpdateCompositionHookInput defines input fields for updating a composition hook resource. NOTE: This API does not support partial updates, please supply all necesary fields

type UpdateCompositionHookResponse

type UpdateCompositionHookResponse struct {
	AccountSid           string                 `json:"account_sid"`
	AudioSources         []string               `json:"audio_sources"`
	AudioSourcesExcluded []string               `json:"audio_sources_excluded"`
	DateCreated          time.Time              `json:"date_created"`
	DateUpdated          *time.Time             `json:"date_updated,omitempty"`
	Enabled              bool                   `json:"enabled"`
	Format               string                 `json:"format"`
	FriendlyName         string                 `json:"friendly_name"`
	Resolution           string                 `json:"resolution"`
	Sid                  string                 `json:"sid"`
	StatusCallback       *string                `json:"status_callback,omitempty"`
	StatusCallbackMethod string                 `json:"status_callback_method"`
	Trim                 bool                   `json:"trim"`
	URL                  string                 `json:"url"`
	VideoLayout          map[string]interface{} `json:"video_layout"`
}

UpdateCompositionHookResponse defines the response fields for the updated composition hook