openapi

package
v1.16.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 14, 2024 License: MIT Imports: 6 Imported by: 0

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.52.1
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://media.twilio.com

Class Method HTTP request Description
MediaProcessorsApi CreateMediaProcessor Post /v1/MediaProcessors
MediaProcessorsApi FetchMediaProcessor Get /v1/MediaProcessors/{Sid}
MediaProcessorsApi ListMediaProcessor Get /v1/MediaProcessors
MediaProcessorsApi UpdateMediaProcessor Post /v1/MediaProcessors/{Sid}
MediaRecordingsApi DeleteMediaRecording Delete /v1/MediaRecordings/{Sid}
MediaRecordingsApi FetchMediaRecording Get /v1/MediaRecordings/{Sid}
MediaRecordingsApi ListMediaRecording Get /v1/MediaRecordings
PlayerStreamersApi CreatePlayerStreamer Post /v1/PlayerStreamers
PlayerStreamersApi FetchPlayerStreamer Get /v1/PlayerStreamers/{Sid}
PlayerStreamersApi ListPlayerStreamer Get /v1/PlayerStreamers
PlayerStreamersApi UpdatePlayerStreamer Post /v1/PlayerStreamers/{Sid}
PlayerStreamersPlaybackGrantApi CreatePlayerStreamerPlaybackGrant Post /v1/PlayerStreamers/{Sid}/PlaybackGrant
PlayerStreamersPlaybackGrantApi FetchPlayerStreamerPlaybackGrant Get /v1/PlayerStreamers/{Sid}/PlaybackGrant

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService 

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

func NewApiService 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateMediaProcessor 

func (c *ApiService) CreateMediaProcessor(params *CreateMediaProcessorParams) (*MediaV1MediaProcessor, error)

func (*ApiService) CreatePlayerStreamer 

func (c *ApiService) CreatePlayerStreamer(params *CreatePlayerStreamerParams) (*MediaV1PlayerStreamer, error)

func (*ApiService) CreatePlayerStreamerPlaybackGrant 

func (c *ApiService) CreatePlayerStreamerPlaybackGrant(Sid string, params *CreatePlayerStreamerPlaybackGrantParams) (*MediaV1PlayerStreamerPlaybackGrant, error)

func (*ApiService) DeleteMediaRecording added in v0.22.2 

func (c *ApiService) DeleteMediaRecording(Sid string) error

Deletes a MediaRecording resource identified by a SID.

func (*ApiService) FetchMediaProcessor 

func (c *ApiService) FetchMediaProcessor(Sid string) (*MediaV1MediaProcessor, error)

Returns a single MediaProcessor resource identified by a SID.

func (*ApiService) FetchMediaRecording added in v0.22.2 

func (c *ApiService) FetchMediaRecording(Sid string) (*MediaV1MediaRecording, error)

Returns a single MediaRecording resource identified by a SID.

func (*ApiService) FetchPlayerStreamer 

func (c *ApiService) FetchPlayerStreamer(Sid string) (*MediaV1PlayerStreamer, error)

Returns a single PlayerStreamer resource identified by a SID.

func (*ApiService) FetchPlayerStreamerPlaybackGrant 

func (c *ApiService) FetchPlayerStreamerPlaybackGrant(Sid string) (*MediaV1PlayerStreamerPlaybackGrant, error)

**This method is not enabled.** Returns a single PlaybackGrant resource identified by a SID.

func (*ApiService) ListMediaProcessor 

func (c *ApiService) ListMediaProcessor(params *ListMediaProcessorParams) ([]MediaV1MediaProcessor, error)

Lists MediaProcessor records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListMediaRecording added in v0.22.2 

func (c *ApiService) ListMediaRecording(params *ListMediaRecordingParams) ([]MediaV1MediaRecording, error)

Lists MediaRecording records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListPlayerStreamer 

func (c *ApiService) ListPlayerStreamer(params *ListPlayerStreamerParams) ([]MediaV1PlayerStreamer, error)

Lists PlayerStreamer records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageMediaProcessor 

func (c *ApiService) PageMediaProcessor(params *ListMediaProcessorParams, pageToken, pageNumber string) (*ListMediaProcessorResponse, error)

Retrieve a single page of MediaProcessor records from the API. Request is executed immediately.

func (*ApiService) PageMediaRecording added in v0.22.2 

func (c *ApiService) PageMediaRecording(params *ListMediaRecordingParams, pageToken, pageNumber string) (*ListMediaRecordingResponse, error)

Retrieve a single page of MediaRecording records from the API. Request is executed immediately.

func (*ApiService) PagePlayerStreamer 

func (c *ApiService) PagePlayerStreamer(params *ListPlayerStreamerParams, pageToken, pageNumber string) (*ListPlayerStreamerResponse, error)

Retrieve a single page of PlayerStreamer records from the API. Request is executed immediately.

func (*ApiService) StreamMediaProcessor 

func (c *ApiService) StreamMediaProcessor(params *ListMediaProcessorParams) (chan MediaV1MediaProcessor, chan error)

Streams MediaProcessor records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamMediaRecording added in v0.22.2 

func (c *ApiService) StreamMediaRecording(params *ListMediaRecordingParams) (chan MediaV1MediaRecording, chan error)

Streams MediaRecording records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamPlayerStreamer 

func (c *ApiService) StreamPlayerStreamer(params *ListPlayerStreamerParams) (chan MediaV1PlayerStreamer, chan error)

Streams PlayerStreamer records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateMediaProcessor 

func (c *ApiService) UpdateMediaProcessor(Sid string, params *UpdateMediaProcessorParams) (*MediaV1MediaProcessor, error)

Updates a MediaProcessor resource identified by a SID.

func (*ApiService) UpdatePlayerStreamer 

func (c *ApiService) UpdatePlayerStreamer(Sid string, params *UpdatePlayerStreamerParams) (*MediaV1PlayerStreamer, error)

Updates a PlayerStreamer resource identified by a SID.

type CreateMediaProcessorParams 

type CreateMediaProcessorParams struct {
	// The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`
	Extension *string `json:"Extension,omitempty"`
	// The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.
	ExtensionContext *string `json:"ExtensionContext,omitempty"`
	// User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about whether you need to provide this.
	ExtensionEnvironment *interface{} `json:"ExtensionEnvironment,omitempty"`
	// The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
	StatusCallbackMethod *string `json:"StatusCallbackMethod,omitempty"`
	// The maximum time, in seconds, that the MediaProcessor can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the MediaProcessor, regardless of whether media is still streaming.
	MaxDuration *int `json:"MaxDuration,omitempty"`
}

Optional parameters for the method 'CreateMediaProcessor'

func (*CreateMediaProcessorParams) SetExtension 

func (params *CreateMediaProcessorParams) SetExtension(Extension string) *CreateMediaProcessorParams

func (*CreateMediaProcessorParams) SetExtensionContext 

func (params *CreateMediaProcessorParams) SetExtensionContext(ExtensionContext string) *CreateMediaProcessorParams

func (*CreateMediaProcessorParams) SetExtensionEnvironment 

func (params *CreateMediaProcessorParams) SetExtensionEnvironment(ExtensionEnvironment interface{}) *CreateMediaProcessorParams

func (*CreateMediaProcessorParams) SetMaxDuration added in v0.19.0 

func (params *CreateMediaProcessorParams) SetMaxDuration(MaxDuration int) *CreateMediaProcessorParams

func (*CreateMediaProcessorParams) SetStatusCallback 

func (params *CreateMediaProcessorParams) SetStatusCallback(StatusCallback string) *CreateMediaProcessorParams

func (*CreateMediaProcessorParams) SetStatusCallbackMethod 

func (params *CreateMediaProcessorParams) SetStatusCallbackMethod(StatusCallbackMethod string) *CreateMediaProcessorParams

type CreatePlayerStreamerParams 

type CreatePlayerStreamerParams struct {
	// Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`.
	Video *bool `json:"Video,omitempty"`
	// The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
	StatusCallbackMethod *string `json:"StatusCallbackMethod,omitempty"`
	// The maximum time, in seconds, that the PlayerStreamer is active (`created` or `started`) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming.
	MaxDuration *int `json:"MaxDuration,omitempty"`
}

Optional parameters for the method 'CreatePlayerStreamer'

func (*CreatePlayerStreamerParams) SetMaxDuration added in v0.23.0 

func (params *CreatePlayerStreamerParams) SetMaxDuration(MaxDuration int) *CreatePlayerStreamerParams

func (*CreatePlayerStreamerParams) SetStatusCallback 

func (params *CreatePlayerStreamerParams) SetStatusCallback(StatusCallback string) *CreatePlayerStreamerParams

func (*CreatePlayerStreamerParams) SetStatusCallbackMethod 

func (params *CreatePlayerStreamerParams) SetStatusCallbackMethod(StatusCallbackMethod string) *CreatePlayerStreamerParams

func (*CreatePlayerStreamerParams) SetVideo 

func (params *CreatePlayerStreamerParams) SetVideo(Video bool) *CreatePlayerStreamerParams

type CreatePlayerStreamerPlaybackGrantParams 

type CreatePlayerStreamerPlaybackGrantParams struct {
	// The time to live of the PlaybackGrant. Default value is 15 seconds. Maximum value is 60 seconds.
	Ttl *int `json:"Ttl,omitempty"`
	// The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain.
	AccessControlAllowOrigin *string `json:"AccessControlAllowOrigin,omitempty"`
}

Optional parameters for the method 'CreatePlayerStreamerPlaybackGrant'

func (*CreatePlayerStreamerPlaybackGrantParams) SetAccessControlAllowOrigin 

func (params *CreatePlayerStreamerPlaybackGrantParams) SetAccessControlAllowOrigin(AccessControlAllowOrigin string) *CreatePlayerStreamerPlaybackGrantParams

func (*CreatePlayerStreamerPlaybackGrantParams) SetTtl 

func (params *CreatePlayerStreamerPlaybackGrantParams) SetTtl(Ttl int) *CreatePlayerStreamerPlaybackGrantParams

type ListMediaProcessorParams 

type ListMediaProcessorParams struct {
	// The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.
	Order *string `json:"Order,omitempty"`
	// Status to filter by, with possible values `started`, `ended` or `failed`.
	Status *string `json:"Status,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListMediaProcessor'

func (*ListMediaProcessorParams) SetLimit 

func (params *ListMediaProcessorParams) SetLimit(Limit int) *ListMediaProcessorParams

func (*ListMediaProcessorParams) SetOrder 

func (params *ListMediaProcessorParams) SetOrder(Order string) *ListMediaProcessorParams

func (*ListMediaProcessorParams) SetPageSize 

func (params *ListMediaProcessorParams) SetPageSize(PageSize int) *ListMediaProcessorParams

func (*ListMediaProcessorParams) SetStatus 

func (params *ListMediaProcessorParams) SetStatus(Status string) *ListMediaProcessorParams

type ListMediaProcessorResponse 

type ListMediaProcessorResponse struct {
	MediaProcessors []MediaV1MediaProcessor        `json:"media_processors,omitempty"`
	Meta            ListMediaProcessorResponseMeta `json:"meta,omitempty"`
}

ListMediaProcessorResponse struct for ListMediaProcessorResponse

type ListMediaProcessorResponseMeta 

type ListMediaProcessorResponseMeta struct {
	FirstPageUrl    string  `json:"first_page_url,omitempty"`
	NextPageUrl     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page,omitempty"`
	PageSize        int     `json:"page_size,omitempty"`
	PreviousPageUrl *string `json:"previous_page_url,omitempty"`
	Url             string  `json:"url,omitempty"`
	Key             string  `json:"key,omitempty"`
}

ListMediaProcessorResponseMeta struct for ListMediaProcessorResponseMeta

type ListMediaRecordingParams added in v0.22.2 

type ListMediaRecordingParams struct {
	// The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.
	Order *string `json:"Order,omitempty"`
	// Status to filter by, with possible values `processing`, `completed`, `deleted`, or `failed`.
	Status *string `json:"Status,omitempty"`
	// SID of a MediaProcessor to filter by.
	ProcessorSid *string `json:"ProcessorSid,omitempty"`
	// SID of a MediaRecording source to filter by.
	SourceSid *string `json:"SourceSid,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListMediaRecording'

func (*ListMediaRecordingParams) SetLimit added in v0.22.2 

func (params *ListMediaRecordingParams) SetLimit(Limit int) *ListMediaRecordingParams

func (*ListMediaRecordingParams) SetOrder added in v0.22.2 

func (params *ListMediaRecordingParams) SetOrder(Order string) *ListMediaRecordingParams

func (*ListMediaRecordingParams) SetPageSize added in v0.22.2 

func (params *ListMediaRecordingParams) SetPageSize(PageSize int) *ListMediaRecordingParams

func (*ListMediaRecordingParams) SetProcessorSid added in v0.23.0 

func (params *ListMediaRecordingParams) SetProcessorSid(ProcessorSid string) *ListMediaRecordingParams

func (*ListMediaRecordingParams) SetSourceSid added in v0.23.0 

func (params *ListMediaRecordingParams) SetSourceSid(SourceSid string) *ListMediaRecordingParams

func (*ListMediaRecordingParams) SetStatus added in v0.22.2 

func (params *ListMediaRecordingParams) SetStatus(Status string) *ListMediaRecordingParams

type ListMediaRecordingResponse added in v0.22.2 

type ListMediaRecordingResponse struct {
	MediaRecordings []MediaV1MediaRecording        `json:"media_recordings,omitempty"`
	Meta            ListMediaProcessorResponseMeta `json:"meta,omitempty"`
}

ListMediaRecordingResponse struct for ListMediaRecordingResponse

type ListPlayerStreamerParams 

type ListPlayerStreamerParams struct {
	// The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.
	Order *string `json:"Order,omitempty"`
	// Status to filter by, with possible values `created`, `started`, `ended`, or `failed`.
	Status *string `json:"Status,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListPlayerStreamer'

func (*ListPlayerStreamerParams) SetLimit 

func (params *ListPlayerStreamerParams) SetLimit(Limit int) *ListPlayerStreamerParams

func (*ListPlayerStreamerParams) SetOrder 

func (params *ListPlayerStreamerParams) SetOrder(Order string) *ListPlayerStreamerParams

func (*ListPlayerStreamerParams) SetPageSize 

func (params *ListPlayerStreamerParams) SetPageSize(PageSize int) *ListPlayerStreamerParams

func (*ListPlayerStreamerParams) SetStatus 

func (params *ListPlayerStreamerParams) SetStatus(Status string) *ListPlayerStreamerParams

type ListPlayerStreamerResponse 

type ListPlayerStreamerResponse struct {
	PlayerStreamers []MediaV1PlayerStreamer        `json:"player_streamers,omitempty"`
	Meta            ListMediaProcessorResponseMeta `json:"meta,omitempty"`
}

ListPlayerStreamerResponse struct for ListPlayerStreamerResponse

type MediaV1MediaProcessor 

type MediaV1MediaProcessor struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MediaProcessor resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string generated to identify the MediaProcessor resource.
	Sid *string `json:"sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`
	Extension *string `json:"extension,omitempty"`
	// The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.
	ExtensionContext *string `json:"extension_context,omitempty"`
	Status           *string `json:"status,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The reason why a MediaProcessor ended. When a MediaProcessor is in progress, will be `null`. When a MediaProcessor is completed, can be `ended-via-api`, `max-duration-exceeded`, `error-loading-extension`, `error-streaming-media` or `internal-service-error`. See [ended reasons](/docs/live/api/mediaprocessors#mediaprocessor-ended-reason-values) for more details.
	EndedReason *string `json:"ended_reason,omitempty"`
	// The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
	StatusCallbackMethod *string `json:"status_callback_method,omitempty"`
	// The maximum time, in seconds, that the MediaProcessor can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the MediaProcessor, regardless of whether media is still streaming.
	MaxDuration *int `json:"max_duration,omitempty"`
}

MediaV1MediaProcessor struct for MediaV1MediaProcessor

type MediaV1MediaRecording added in v0.22.2 

type MediaV1MediaRecording struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MediaRecording resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The duration of the MediaRecording in seconds.
	Duration *int    `json:"duration,omitempty"`
	Format   *string `json:"format,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The SID of the MediaProcessor resource which produced the MediaRecording.
	ProcessorSid *string `json:"processor_sid,omitempty"`
	// The dimensions of the video image in pixels expressed as columns (width) and rows (height).
	Resolution *string `json:"resolution,omitempty"`
	// The SID of the resource that generated the original media track(s) of the MediaRecording.
	SourceSid *string `json:"source_sid,omitempty"`
	// The unique string generated to identify the MediaRecording resource.
	Sid *string `json:"sid,omitempty"`
	// The size of the recording media in bytes.
	MediaSize *int64  `json:"media_size,omitempty"`
	Status    *string `json:"status,omitempty"`
	// The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
	StatusCallbackMethod *string `json:"status_callback_method,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

MediaV1MediaRecording struct for MediaV1MediaRecording

type MediaV1PlayerStreamer 

type MediaV1PlayerStreamer struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PlayerStreamer resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`.
	Video *bool `json:"video,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string generated to identify the PlayerStreamer resource.
	Sid    *string `json:"sid,omitempty"`
	Status *string `json:"status,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
	StatusCallbackMethod *string `json:"status_callback_method,omitempty"`
	EndedReason          *string `json:"ended_reason,omitempty"`
	// The maximum time, in seconds, that the PlayerStreamer is active (`created` or `started`) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming.
	MaxDuration *int `json:"max_duration,omitempty"`
}

MediaV1PlayerStreamer struct for MediaV1PlayerStreamer

type MediaV1PlayerStreamerPlaybackGrant 

type MediaV1PlayerStreamerPlaybackGrant struct {
	// The unique string generated to identify the PlayerStreamer resource that this PlaybackGrant authorizes views for.
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The grant that authorizes the player sdk to connect to the livestream
	Grant *interface{} `json:"grant,omitempty"`
}

MediaV1PlayerStreamerPlaybackGrant struct for MediaV1PlayerStreamerPlaybackGrant

type UpdateMediaProcessorParams 

type UpdateMediaProcessorParams struct {
	//
	Status *string `json:"Status,omitempty"`
}

Optional parameters for the method 'UpdateMediaProcessor'

func (*UpdateMediaProcessorParams) SetStatus 

func (params *UpdateMediaProcessorParams) SetStatus(Status string) *UpdateMediaProcessorParams

type UpdatePlayerStreamerParams 

type UpdatePlayerStreamerParams struct {
	//
	Status *string `json:"Status,omitempty"`
}

Optional parameters for the method 'UpdatePlayerStreamer'

func (*UpdatePlayerStreamerParams) SetStatus 

func (params *UpdatePlayerStreamerParams) SetStatus(Status string) *UpdatePlayerStreamerParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.