compositions

Documentation

Overview

Package compositions contains auto-generated files. DO NOT MODIFY

Package compositions contains auto-generated files. DO NOT MODIFY

Package compositions contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateCompositionInput) (*CreateCompositionResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateCompositionInput) (*CreateCompositionResponse, error)
  • func (c *Client) NewCompositionsPaginator() *CompositionsPaginator
  • func (c *Client) NewCompositionsPaginatorWithOptions(options *CompositionsPageOptions) *CompositionsPaginator
  • func (c Client) Page(options *CompositionsPageOptions) (*CompositionsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *CompositionsPageOptions) (*CompositionsPageResponse, error)
• type CompositionsPage
• type CompositionsPageOptions
• type CompositionsPageResponse
• type CompositionsPaginator
  • func (p *CompositionsPaginator) CurrentPage() *CompositionsPageResponse
  • func (p *CompositionsPaginator) Error() error
  • func (p *CompositionsPaginator) Next() bool
  • func (p *CompositionsPaginator) NextWithContext(context context.Context) bool
• type CreateCompositionInput
• type CreateCompositionResponse
• type PageCompositionResponse
• type PageMetaResponse

Types

type Client

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

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

func New

func New(client *client.Client) *Client

New creates a new instance of the compositions client

func (Client) Create

func (c Client) Create(input *CreateCompositionInput) (*CreateCompositionResponse, error)

Create creates a new composition See https://www.twilio.com/docs/video/api/compositions-resource#create-composition-http-post for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateCompositionInput) (*CreateCompositionResponse, error)

CreateWithContext creates a new composition See https://www.twilio.com/docs/video/api/compositions-resource#create-composition-http-post for more details

func (*Client) NewCompositionsPaginator

func (c *Client) NewCompositionsPaginator() *CompositionsPaginator

NewCompositionsPaginator creates a new instance of the paginator for Page.

func (*Client) NewCompositionsPaginatorWithOptions

func (c *Client) NewCompositionsPaginatorWithOptions(options *CompositionsPageOptions) *CompositionsPaginator

NewCompositionsPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *CompositionsPageOptions) (*CompositionsPageResponse, error)

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

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *CompositionsPageOptions) (*CompositionsPageResponse, error)

PageWithContext retrieves a page of compositions See https://www.twilio.com/docs/video/api/compositions-resource#get-list-http-get for more details

type CompositionsPage

type CompositionsPage struct {
	CurrentPage *CompositionsPageResponse
	Error       error
	// contains filtered or unexported fields
}

CompositionsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageCompositionResponse or error that is returned from the api call(s)

type CompositionsPageOptions

type CompositionsPageOptions struct {
	PageSize          *int
	Page              *int
	PageToken         *string
	Status            *string
	RoomSid           *string
	DateCreatedAfter  *string
	DateCreatedBefore *string
}

CompositionsPageOptions defines the query options for the api operation

type CompositionsPageResponse

type CompositionsPageResponse struct {
	Compositions []PageCompositionResponse `json:"compositions"`
	Meta         PageMetaResponse          `json:"meta"`
}

CompositionsPageResponse defines the response fields for the compositions page

type CompositionsPaginator

type CompositionsPaginator struct {
	Page         *CompositionsPage
	Compositions []PageCompositionResponse
	// contains filtered or unexported fields
}

CompositionsPaginator defines the fields for makings paginated api calls Compositions is an array of compositions that have been returned from all of the page calls

func (*CompositionsPaginator) CurrentPage

func (p *CompositionsPaginator) CurrentPage() *CompositionsPageResponse

CurrentPage retrieves the results for the current page

func (*CompositionsPaginator) Error

func (p *CompositionsPaginator) Error() error

Error retrieves the error returned from the page

func (*CompositionsPaginator) Next

func (p *CompositionsPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*CompositionsPaginator) NextWithContext

func (p *CompositionsPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate

type CreateCompositionInput

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

CreateCompositionInput defines the input fields for creating a new composition

type CreateCompositionResponse

type CreateCompositionResponse 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"`
}

CreateCompositionResponse defines the response fields for the created composition

type PageCompositionResponse

type PageCompositionResponse 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"`
}

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}