stream

Documentation

Index

• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) GetStreamStatus(paramss ...*GetStreamStatusParams) (*GetStreamStatusResponse, error)
  • func (c *Client) SendStreamCaption(params *SendStreamCaptionParams) (*SendStreamCaptionResponse, error)
  • func (c *Client) StartStream(paramss ...*StartStreamParams) (*StartStreamResponse, error)
  • func (c *Client) StopStream(paramss ...*StopStreamParams) (*StopStreamResponse, error)
  • func (c *Client) ToggleStream(paramss ...*ToggleStreamParams) (*ToggleStreamResponse, error)
• type GetStreamStatusParams
  • func (o *GetStreamStatusParams) GetRequestName() string
• type GetStreamStatusResponse
• type SendStreamCaptionParams
  • func NewSendStreamCaptionParams() *SendStreamCaptionParams
  • func (o *SendStreamCaptionParams) GetRequestName() string
  • func (o *SendStreamCaptionParams) WithCaptionText(x string) *SendStreamCaptionParams
• type SendStreamCaptionResponse
• type StartStreamParams
  • func (o *StartStreamParams) GetRequestName() string
• type StartStreamResponse
• type StopStreamParams
  • func (o *StopStreamParams) GetRequestName() string
• type StopStreamResponse
• type ToggleStreamParams
  • func (o *ToggleStreamParams) GetRequestName() string
• type ToggleStreamResponse

Types

type Client

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

Client represents a client for 'stream' requests.

func NewClient

func NewClient(c *api.Client) *Client

NewStream returns a new 'stream' client.

func (*Client) GetStreamStatus

func (c *Client) GetStreamStatus(paramss ...*GetStreamStatusParams) (*GetStreamStatusResponse, error)

Gets the status of the stream output.

func (*Client) SendStreamCaption

func (c *Client) SendStreamCaption(params *SendStreamCaptionParams) (*SendStreamCaptionResponse, error)

Sends CEA-608 caption text over the stream output.

func (*Client) StartStream

func (c *Client) StartStream(paramss ...*StartStreamParams) (*StartStreamResponse, error)

Starts the stream output.

func (*Client) StopStream

func (c *Client) StopStream(paramss ...*StopStreamParams) (*StopStreamResponse, error)

Stops the stream output.

func (*Client) ToggleStream

func (c *Client) ToggleStream(paramss ...*ToggleStreamParams) (*ToggleStreamResponse, error)

Toggles the status of the stream output.

type GetStreamStatusParams

type GetStreamStatusParams struct{}

Represents the request body for the GetStreamStatus request.

func (*GetStreamStatusParams) GetRequestName

func (o *GetStreamStatusParams) GetRequestName() string

Returns the associated request.

type GetStreamStatusResponse

type GetStreamStatusResponse struct {

	// Whether the output is active
	OutputActive bool `json:"outputActive,omitempty"`

	// Number of bytes sent by the output
	OutputBytes float64 `json:"outputBytes,omitempty"`

	// Congestion of the output
	OutputCongestion float64 `json:"outputCongestion,omitempty"`

	// Current duration in milliseconds for the output
	OutputDuration float64 `json:"outputDuration,omitempty"`

	// Whether the output is currently reconnecting
	OutputReconnecting bool `json:"outputReconnecting,omitempty"`

	// Number of frames skipped by the output's process
	OutputSkippedFrames float64 `json:"outputSkippedFrames,omitempty"`

	// Current formatted timecode string for the output
	OutputTimecode string `json:"outputTimecode,omitempty"`

	// Total number of frames delivered by the output's process
	OutputTotalFrames float64 `json:"outputTotalFrames,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetStreamStatus request.

type SendStreamCaptionParams

type SendStreamCaptionParams struct {
	// Caption text
	CaptionText *string `json:"captionText,omitempty"`
}

Represents the request body for the SendStreamCaption request.

func NewSendStreamCaptionParams

func NewSendStreamCaptionParams() *SendStreamCaptionParams

func (*SendStreamCaptionParams) GetRequestName

func (o *SendStreamCaptionParams) GetRequestName() string

Returns the associated request.

func (*SendStreamCaptionParams) WithCaptionText

func (o *SendStreamCaptionParams) WithCaptionText(x string) *SendStreamCaptionParams

type SendStreamCaptionResponse

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

Represents the response body for the SendStreamCaption request.

type StartStreamParams

type StartStreamParams struct{}

Represents the request body for the StartStream request.

func (*StartStreamParams) GetRequestName

func (o *StartStreamParams) GetRequestName() string

Returns the associated request.

type StartStreamResponse

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

Represents the response body for the StartStream request.

type StopStreamParams

type StopStreamParams struct{}

Represents the request body for the StopStream request.

func (*StopStreamParams) GetRequestName

func (o *StopStreamParams) GetRequestName() string

Returns the associated request.

type StopStreamResponse

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

Represents the response body for the StopStream request.

type ToggleStreamParams

type ToggleStreamParams struct{}

Represents the request body for the ToggleStream request.

func (*ToggleStreamParams) GetRequestName

func (o *ToggleStreamParams) GetRequestName() string

Returns the associated request.

type ToggleStreamResponse

type ToggleStreamResponse struct {

	// New state of the stream output
	OutputActive bool `json:"outputActive,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the ToggleStream request.