record

Documentation

Index

• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) CreateRecordChapter(paramss ...*CreateRecordChapterParams) (*CreateRecordChapterResponse, error)
  • func (c *Client) GetRecordStatus(paramss ...*GetRecordStatusParams) (*GetRecordStatusResponse, error)
  • func (c *Client) PauseRecord(paramss ...*PauseRecordParams) (*PauseRecordResponse, error)
  • func (c *Client) ResumeRecord(paramss ...*ResumeRecordParams) (*ResumeRecordResponse, error)
  • func (c *Client) SplitRecordFile(paramss ...*SplitRecordFileParams) (*SplitRecordFileResponse, error)
  • func (c *Client) StartRecord(paramss ...*StartRecordParams) (*StartRecordResponse, error)
  • func (c *Client) StopRecord(paramss ...*StopRecordParams) (*StopRecordResponse, error)
  • func (c *Client) ToggleRecord(paramss ...*ToggleRecordParams) (*ToggleRecordResponse, error)
  • func (c *Client) ToggleRecordPause(paramss ...*ToggleRecordPauseParams) (*ToggleRecordPauseResponse, error)
• type CreateRecordChapterParams
  • func NewCreateRecordChapterParams() *CreateRecordChapterParams
  • func (o *CreateRecordChapterParams) GetRequestName() string
  • func (o *CreateRecordChapterParams) WithChapterName(x string) *CreateRecordChapterParams
• type CreateRecordChapterResponse
• type GetRecordStatusParams
  • func (o *GetRecordStatusParams) GetRequestName() string
• type GetRecordStatusResponse
• type PauseRecordParams
  • func (o *PauseRecordParams) GetRequestName() string
• type PauseRecordResponse
• type ResumeRecordParams
  • func (o *ResumeRecordParams) GetRequestName() string
• type ResumeRecordResponse
• type SplitRecordFileParams
  • func (o *SplitRecordFileParams) GetRequestName() string
• type SplitRecordFileResponse
• type StartRecordParams
  • func (o *StartRecordParams) GetRequestName() string
• type StartRecordResponse
• type StopRecordParams
  • func (o *StopRecordParams) GetRequestName() string
• type StopRecordResponse
• type ToggleRecordParams
  • func (o *ToggleRecordParams) GetRequestName() string
• type ToggleRecordPauseParams
  • func (o *ToggleRecordPauseParams) GetRequestName() string
• type ToggleRecordPauseResponse
• type ToggleRecordResponse

Types

type Client

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

Client represents a client for 'record' requests.

func NewClient

func NewClient(c *api.Client) *Client

NewRecord returns a new 'record' client.

func (*Client) CreateRecordChapter

func (c *Client) CreateRecordChapter(paramss ...*CreateRecordChapterParams) (*CreateRecordChapterResponse, error)

Adds a new chapter marker to the file currently being recorded.

Note: As of OBS 30.2.0, the only file format supporting this feature is Hybrid MP4.

func (*Client) GetRecordStatus

func (c *Client) GetRecordStatus(paramss ...*GetRecordStatusParams) (*GetRecordStatusResponse, error)

Gets the status of the record output.

func (*Client) PauseRecord

func (c *Client) PauseRecord(paramss ...*PauseRecordParams) (*PauseRecordResponse, error)

Pauses the record output.

func (*Client) ResumeRecord

func (c *Client) ResumeRecord(paramss ...*ResumeRecordParams) (*ResumeRecordResponse, error)

Resumes the record output.

func (*Client) SplitRecordFile

func (c *Client) SplitRecordFile(paramss ...*SplitRecordFileParams) (*SplitRecordFileResponse, error)

Splits the current file being recorded into a new file.

func (*Client) StartRecord

func (c *Client) StartRecord(paramss ...*StartRecordParams) (*StartRecordResponse, error)

Starts the record output.

func (*Client) StopRecord

func (c *Client) StopRecord(paramss ...*StopRecordParams) (*StopRecordResponse, error)

Stops the record output.

func (*Client) ToggleRecord

func (c *Client) ToggleRecord(paramss ...*ToggleRecordParams) (*ToggleRecordResponse, error)

Toggles the status of the record output.

func (*Client) ToggleRecordPause

func (c *Client) ToggleRecordPause(paramss ...*ToggleRecordPauseParams) (*ToggleRecordPauseResponse, error)

Toggles pause on the record output.

type CreateRecordChapterParams

type CreateRecordChapterParams struct {
	// Name of the new chapter
	ChapterName *string `json:"chapterName,omitempty"`
}

Represents the request body for the CreateRecordChapter request.

func NewCreateRecordChapterParams

func NewCreateRecordChapterParams() *CreateRecordChapterParams

func (*CreateRecordChapterParams) GetRequestName

func (o *CreateRecordChapterParams) GetRequestName() string

Returns the associated request.

func (*CreateRecordChapterParams) WithChapterName

func (o *CreateRecordChapterParams) WithChapterName(x string) *CreateRecordChapterParams

type CreateRecordChapterResponse

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

Represents the response body for the CreateRecordChapter request.

type GetRecordStatusParams

type GetRecordStatusParams struct{}

Represents the request body for the GetRecordStatus request.

func (*GetRecordStatusParams) GetRequestName

func (o *GetRecordStatusParams) GetRequestName() string

Returns the associated request.

type GetRecordStatusResponse

type GetRecordStatusResponse struct {

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

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

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

	// Whether the output is paused
	OutputPaused bool `json:"outputPaused,omitempty"`

	// Current formatted timecode string for the output
	OutputTimecode string `json:"outputTimecode,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetRecordStatus request.

type PauseRecordParams

type PauseRecordParams struct{}

Represents the request body for the PauseRecord request.

func (*PauseRecordParams) GetRequestName

func (o *PauseRecordParams) GetRequestName() string

Returns the associated request.

type PauseRecordResponse

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

Represents the response body for the PauseRecord request.

type ResumeRecordParams

type ResumeRecordParams struct{}

Represents the request body for the ResumeRecord request.

func (*ResumeRecordParams) GetRequestName

func (o *ResumeRecordParams) GetRequestName() string

Returns the associated request.

type ResumeRecordResponse

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

Represents the response body for the ResumeRecord request.

type SplitRecordFileParams

type SplitRecordFileParams struct{}

Represents the request body for the SplitRecordFile request.

func (*SplitRecordFileParams) GetRequestName

func (o *SplitRecordFileParams) GetRequestName() string

Returns the associated request.

type SplitRecordFileResponse

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

Represents the response body for the SplitRecordFile request.

type StartRecordParams

type StartRecordParams struct{}

Represents the request body for the StartRecord request.

func (*StartRecordParams) GetRequestName

func (o *StartRecordParams) GetRequestName() string

Returns the associated request.

type StartRecordResponse

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

Represents the response body for the StartRecord request.

type StopRecordParams

type StopRecordParams struct{}

Represents the request body for the StopRecord request.

func (*StopRecordParams) GetRequestName

func (o *StopRecordParams) GetRequestName() string

Returns the associated request.

type StopRecordResponse

type StopRecordResponse struct {

	// File name for the saved recording
	OutputPath string `json:"outputPath,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the StopRecord request.

type ToggleRecordParams

type ToggleRecordParams struct{}

Represents the request body for the ToggleRecord request.

func (*ToggleRecordParams) GetRequestName

func (o *ToggleRecordParams) GetRequestName() string

Returns the associated request.

type ToggleRecordPauseParams

type ToggleRecordPauseParams struct{}

Represents the request body for the ToggleRecordPause request.

func (*ToggleRecordPauseParams) GetRequestName

func (o *ToggleRecordPauseParams) GetRequestName() string

Returns the associated request.

type ToggleRecordPauseResponse

type ToggleRecordPauseResponse struct {
	OutputPaused bool `json:"outputPaused,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the ToggleRecordPause request.

type ToggleRecordResponse

type ToggleRecordResponse struct {

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

Represents the response body for the ToggleRecord request.