streaming

package
v0.8.0 Latest Latest
Warning

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

 Go to latest Published: Dec 29, 2021 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*requests.Client
}

Client represents a client for 'streaming' requests.

func (*Client) GetStreamSettings 

func (c *Client) GetStreamSettings(paramss ...*GetStreamSettingsParams) (*GetStreamSettingsResponse, error)

GetStreamSettings sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) GetStreamingStatus 

func (c *Client) GetStreamingStatus(paramss ...*GetStreamingStatusParams) (*GetStreamingStatusResponse, error)

GetStreamingStatus sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) SaveStreamSettings 

func (c *Client) SaveStreamSettings(paramss ...*SaveStreamSettingsParams) (*SaveStreamSettingsResponse, error)

SaveStreamSettings sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) SendCaptions added in v0.2.0 

func (c *Client) SendCaptions(params *SendCaptionsParams) (*SendCaptionsResponse, error)

SendCaptions sends the corresponding request to the connected OBS WebSockets server.

func (*Client) SetStreamSettings 

func (c *Client) SetStreamSettings(params *SetStreamSettingsParams) (*SetStreamSettingsResponse, error)

SetStreamSettings sends the corresponding request to the connected OBS WebSockets server.

func (*Client) StartStopStreaming 

func (c *Client) StartStopStreaming(paramss ...*StartStopStreamingParams) (*StartStopStreamingResponse, error)

StartStopStreaming sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) StartStreaming 

func (c *Client) StartStreaming(params *StartStreamingParams) (*StartStreamingResponse, error)

StartStreaming sends the corresponding request to the connected OBS WebSockets server.

func (*Client) StopStreaming 

func (c *Client) StopStreaming(paramss ...*StopStreamingParams) (*StopStreamingResponse, error)

StopStreaming sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

type GetStreamSettingsParams 

type GetStreamSettingsParams struct {
	requests.ParamsBasic
}

GetStreamSettingsParams represents the params body for the "GetStreamSettings" request. Get the current streaming server settings. Since 4.1.0.

func (*GetStreamSettingsParams) GetSelfName added in v0.5.0 

func (o *GetStreamSettingsParams) GetSelfName() string

GetSelfName just returns "GetStreamSettings".

type GetStreamSettingsResponse 

type GetStreamSettingsResponse struct {
	requests.ResponseBasic

	//
	Settings *typedefs.StreamSettings `json:"settings,omitempty"`

	// The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'.
	Type string `json:"type,omitempty"`
}

GetStreamSettingsResponse represents the response body for the "GetStreamSettings" request. Get the current streaming server settings. Since v4.1.0.

type GetStreamingStatusParams 

type GetStreamingStatusParams struct {
	requests.ParamsBasic
}

GetStreamingStatusParams represents the params body for the "GetStreamingStatus" request. Get current streaming and recording status. Since 0.3.

func (*GetStreamingStatusParams) GetSelfName added in v0.5.0 

func (o *GetStreamingStatusParams) GetSelfName() string

GetSelfName just returns "GetStreamingStatus".

type GetStreamingStatusResponse 

type GetStreamingStatusResponse struct {
	requests.ResponseBasic

	// Always false. Retrocompatibility with OBSRemote.
	PreviewOnly bool `json:"preview-only,omitempty"`

	// Time elapsed since recording started (only present if currently recording).
	RecTimecode string `json:"rec-timecode,omitempty"`

	// Current recording status.
	Recording bool `json:"recording,omitempty"`

	// If recording is paused.
	RecordingPaused bool `json:"recording-paused,omitempty"`

	// Time elapsed since streaming started (only present if currently streaming).
	StreamTimecode string `json:"stream-timecode,omitempty"`

	// Current streaming status.
	Streaming bool `json:"streaming,omitempty"`

	// Current virtual cam status.
	Virtualcam bool `json:"virtualcam,omitempty"`

	// Time elapsed since virtual cam started (only present if virtual cam currently active).
	VirtualcamTimecode string `json:"virtualcam-timecode,omitempty"`
}

GetStreamingStatusResponse represents the response body for the "GetStreamingStatus" request. Get current streaming and recording status. Since v0.3.

type SaveStreamSettingsParams 

type SaveStreamSettingsParams struct {
	requests.ParamsBasic
}

SaveStreamSettingsParams represents the params body for the "SaveStreamSettings" request. Save the current streaming server settings to disk. Since 4.1.0.

func (*SaveStreamSettingsParams) GetSelfName added in v0.5.0 

func (o *SaveStreamSettingsParams) GetSelfName() string

GetSelfName just returns "SaveStreamSettings".

type SaveStreamSettingsResponse 

type SaveStreamSettingsResponse struct {
	requests.ResponseBasic
}

SaveStreamSettingsResponse represents the response body for the "SaveStreamSettings" request. Save the current streaming server settings to disk. Since v4.1.0.

type SendCaptionsParams added in v0.2.0 

type SendCaptionsParams struct {
	requests.ParamsBasic

	// Captions text
	Text string `json:"text,omitempty"`
}

SendCaptionsParams represents the params body for the "SendCaptions" request. Send the provided text as embedded CEA-608 caption data. Since 4.6.0.

func (*SendCaptionsParams) GetSelfName added in v0.5.0 

func (o *SendCaptionsParams) GetSelfName() string

GetSelfName just returns "SendCaptions".

type SendCaptionsResponse added in v0.2.0 

type SendCaptionsResponse struct {
	requests.ResponseBasic
}

SendCaptionsResponse represents the response body for the "SendCaptions" request. Send the provided text as embedded CEA-608 caption data. Since v4.6.0.

type SetStreamSettingsParams 

type SetStreamSettingsParams struct {
	requests.ParamsBasic

	// Persist the settings to disk.
	Save *bool `json:"save,omitempty"`

	//
	Settings *typedefs.StreamSettings `json:"settings,omitempty"`

	// The type of streaming service configuration, usually `rtmp_custom` or `rtmp_common`.
	Type string `json:"type,omitempty"`
}

SetStreamSettingsParams represents the params body for the "SetStreamSettings" request. Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings). Since 4.1.0.

func (*SetStreamSettingsParams) GetSelfName added in v0.5.0 

func (o *SetStreamSettingsParams) GetSelfName() string

GetSelfName just returns "SetStreamSettings".

type SetStreamSettingsResponse 

type SetStreamSettingsResponse struct {
	requests.ResponseBasic
}

SetStreamSettingsResponse represents the response body for the "SetStreamSettings" request. Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings). Since v4.1.0.

type StartStopStreamingParams 

type StartStopStreamingParams struct {
	requests.ParamsBasic
}

StartStopStreamingParams represents the params body for the "StartStopStreaming" request. Toggle streaming on or off (depending on the current stream state). Since 0.3.

func (*StartStopStreamingParams) GetSelfName added in v0.5.0 

func (o *StartStopStreamingParams) GetSelfName() string

GetSelfName just returns "StartStopStreaming".

type StartStopStreamingResponse 

type StartStopStreamingResponse struct {
	requests.ResponseBasic
}

StartStopStreamingResponse represents the response body for the "StartStopStreaming" request. Toggle streaming on or off (depending on the current stream state). Since v0.3.

type StartStreamingParams 

type StartStreamingParams struct {
	requests.ParamsBasic

	Stream *Stream `json:"stream,omitempty"`
}

StartStreamingParams represents the params body for the "StartStreaming" request. Start streaming. Will return an `error` if streaming is already active. Since 4.1.0.

func (*StartStreamingParams) GetSelfName added in v0.5.0 

func (o *StartStreamingParams) GetSelfName() string

GetSelfName just returns "StartStreaming".

type StartStreamingResponse 

type StartStreamingResponse struct {
	requests.ResponseBasic
}

StartStreamingResponse represents the response body for the "StartStreaming" request. Start streaming. Will return an `error` if streaming is already active. Since v4.1.0.

type StopStreamingParams 

type StopStreamingParams struct {
	requests.ParamsBasic
}

StopStreamingParams represents the params body for the "StopStreaming" request. Stop streaming. Will return an `error` if streaming is not active. Since 4.1.0.

func (*StopStreamingParams) GetSelfName added in v0.5.0 

func (o *StopStreamingParams) GetSelfName() string

GetSelfName just returns "StopStreaming".

type StopStreamingResponse 

type StopStreamingResponse struct {
	requests.ResponseBasic
}

StopStreamingResponse represents the response body for the "StopStreaming" request. Stop streaming. Will return an `error` if streaming is not active. Since v4.1.0.

type Stream added in v0.6.0 

type Stream struct {
	// Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass
	// data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	//
	Settings *typedefs.StreamSettings `json:"settings,omitempty"`

	// If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the
	// currently configured stream type does not match the given stream type, all settings must be specified in the
	// `settings` object or an error will occur when starting the stream.
	Type string `json:"type,omitempty"`
}

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.