Documentation
¶
Index ¶
- type 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
- type GetStreamStatusResponse
- type SendStreamCaptionParams
- type SendStreamCaptionResponse
- type StartStreamParams
- type StartStreamResponse
- type StopStreamParams
- type StopStreamResponse
- type ToggleStreamParams
- type ToggleStreamResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client represents a client for 'stream' requests.
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"`
}
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 (*SendStreamCaptionParams) GetRequestName ¶
func (o *SendStreamCaptionParams) GetRequestName() string
Returns the associated request.
type SendStreamCaptionResponse ¶
type SendStreamCaptionResponse struct{}
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{}
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{}
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"`
}
Represents the response body for the ToggleStream request.