recording

package
v0.7.1 Latest Latest
Warning

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

 Go to latest Published: Aug 17, 2021 License: Apache-2.0 Imports: 1 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 'recording' requests.

func (*Client) GetRecordingFolder 

func (c *Client) GetRecordingFolder(paramss ...*GetRecordingFolderParams) (*GetRecordingFolderResponse, error)

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

func (*Client) GetRecordingStatus added in v0.5.0 

func (c *Client) GetRecordingStatus(paramss ...*GetRecordingStatusParams) (*GetRecordingStatusResponse, error)

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

func (*Client) PauseRecording added in v0.3.0 

func (c *Client) PauseRecording(paramss ...*PauseRecordingParams) (*PauseRecordingResponse, error)

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

func (*Client) ResumeRecording added in v0.3.0 

func (c *Client) ResumeRecording(paramss ...*ResumeRecordingParams) (*ResumeRecordingResponse, error)

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

func (*Client) SetRecordingFolder 

func (c *Client) SetRecordingFolder(params *SetRecordingFolderParams) (*SetRecordingFolderResponse, error)

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

func (*Client) StartRecording 

func (c *Client) StartRecording(paramss ...*StartRecordingParams) (*StartRecordingResponse, error)

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

func (*Client) StartStopRecording 

func (c *Client) StartStopRecording(paramss ...*StartStopRecordingParams) (*StartStopRecordingResponse, error)

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

func (*Client) StopRecording 

func (c *Client) StopRecording(paramss ...*StopRecordingParams) (*StopRecordingResponse, error)

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

type GetRecordingFolderParams 

type GetRecordingFolderParams struct {
	requests.ParamsBasic
}

GetRecordingFolderParams represents the params body for the "GetRecordingFolder" request. Get the path of the current recording folder. Since 4.1.0.

func (*GetRecordingFolderParams) GetSelfName added in v0.5.0 

func (o *GetRecordingFolderParams) GetSelfName() string

GetSelfName just returns "GetRecordingFolder".

type GetRecordingFolderResponse 

type GetRecordingFolderResponse struct {
	requests.ResponseBasic

	// Path of the recording folder.
	RecFolder string `json:"rec-folder,omitempty"`
}

GetRecordingFolderResponse represents the response body for the "GetRecordingFolder" request. Get the path of the current recording folder. Since v4.1.0.

type GetRecordingStatusParams added in v0.5.0 

type GetRecordingStatusParams struct {
	requests.ParamsBasic
}

GetRecordingStatusParams represents the params body for the "GetRecordingStatus" request. Get current recording status. Since 4.9.0.

func (*GetRecordingStatusParams) GetSelfName added in v0.5.0 

func (o *GetRecordingStatusParams) GetSelfName() string

GetSelfName just returns "GetRecordingStatus".

type GetRecordingStatusResponse added in v0.5.0 

type GetRecordingStatusResponse struct {
	requests.ResponseBasic

	// Current recording status.
	IsRecording bool `json:"isRecording"`

	// Whether the recording is paused or not.
	IsRecordingPaused bool `json:"isRecordingPaused"`

	// Time elapsed since recording started (only present if currently recording).
	RecordTimecode string `json:"recordTimecode,omitempty"`

	// Absolute path to the recording file (only present if currently recording).
	RecordingFilename string `json:"recordingFilename,omitempty"`
}

GetRecordingStatusResponse represents the response body for the "GetRecordingStatus" request. Get current recording status. Since v4.9.0.

type PauseRecordingParams added in v0.3.0 

type PauseRecordingParams struct {
	requests.ParamsBasic
}

PauseRecordingParams represents the params body for the "PauseRecording" request. Pause the current recording. Returns an error if recording is not active or already paused. Since 4.7.0.

func (*PauseRecordingParams) GetSelfName added in v0.5.0 

func (o *PauseRecordingParams) GetSelfName() string

GetSelfName just returns "PauseRecording".

type PauseRecordingResponse added in v0.3.0 

type PauseRecordingResponse struct {
	requests.ResponseBasic
}

PauseRecordingResponse represents the response body for the "PauseRecording" request. Pause the current recording. Returns an error if recording is not active or already paused. Since v4.7.0.

type ResumeRecordingParams added in v0.3.0 

type ResumeRecordingParams struct {
	requests.ParamsBasic
}

ResumeRecordingParams represents the params body for the "ResumeRecording" request. Resume/unpause the current recording (if paused). Returns an error if recording is not active or not paused. Since 4.7.0.

func (*ResumeRecordingParams) GetSelfName added in v0.5.0 

func (o *ResumeRecordingParams) GetSelfName() string

GetSelfName just returns "ResumeRecording".

type ResumeRecordingResponse added in v0.3.0 

type ResumeRecordingResponse struct {
	requests.ResponseBasic
}

ResumeRecordingResponse represents the response body for the "ResumeRecording" request. Resume/unpause the current recording (if paused). Returns an error if recording is not active or not paused. Since v4.7.0.

type SetRecordingFolderParams 

type SetRecordingFolderParams struct {
	requests.ParamsBasic

	// Path of the recording folder.
	RecFolder string `json:"rec-folder,omitempty"`
}

SetRecordingFolderParams represents the params body for the "SetRecordingFolder" request. In the current profile, sets the recording folder of the Simple and Advanced output modes to the specified value.

Note: If `SetRecordingFolder` is called while a recording is in progress, the change won't be applied immediately and will be effective on the next recording. Since 4.1.0.

func (*SetRecordingFolderParams) GetSelfName added in v0.5.0 

func (o *SetRecordingFolderParams) GetSelfName() string

GetSelfName just returns "SetRecordingFolder".

type SetRecordingFolderResponse 

type SetRecordingFolderResponse struct {
	requests.ResponseBasic
}

SetRecordingFolderResponse represents the response body for the "SetRecordingFolder" request. In the current profile, sets the recording folder of the Simple and Advanced output modes to the specified value.

Note: If `SetRecordingFolder` is called while a recording is in progress, the change won't be applied immediately and will be effective on the next recording. Since v4.1.0.

type StartRecordingParams 

type StartRecordingParams struct {
	requests.ParamsBasic
}

StartRecordingParams represents the params body for the "StartRecording" request. Start recording. Will return an `error` if recording is already active. Since 4.1.0.

func (*StartRecordingParams) GetSelfName added in v0.5.0 

func (o *StartRecordingParams) GetSelfName() string

GetSelfName just returns "StartRecording".

type StartRecordingResponse 

type StartRecordingResponse struct {
	requests.ResponseBasic
}

StartRecordingResponse represents the response body for the "StartRecording" request. Start recording. Will return an `error` if recording is already active. Since v4.1.0.

type StartStopRecordingParams 

type StartStopRecordingParams struct {
	requests.ParamsBasic
}

StartStopRecordingParams represents the params body for the "StartStopRecording" request. Toggle recording on or off (depending on the current recording state). Since 0.3.

func (*StartStopRecordingParams) GetSelfName added in v0.5.0 

func (o *StartStopRecordingParams) GetSelfName() string

GetSelfName just returns "StartStopRecording".

type StartStopRecordingResponse 

type StartStopRecordingResponse struct {
	requests.ResponseBasic
}

StartStopRecordingResponse represents the response body for the "StartStopRecording" request. Toggle recording on or off (depending on the current recording state). Since v0.3.

type StopRecordingParams 

type StopRecordingParams struct {
	requests.ParamsBasic
}

StopRecordingParams represents the params body for the "StopRecording" request. Stop recording. Will return an `error` if recording is not active. Since 4.1.0.

func (*StopRecordingParams) GetSelfName added in v0.5.0 

func (o *StopRecordingParams) GetSelfName() string

GetSelfName just returns "StopRecording".

type StopRecordingResponse 

type StopRecordingResponse struct {
	requests.ResponseBasic
}

StopRecordingResponse represents the response body for the "StopRecording" request. Stop recording. Will return an `error` if recording is not active. Since v4.1.0.

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.