mediainputs

Documentation

Index

• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) GetMediaInputStatus(params *GetMediaInputStatusParams) (*GetMediaInputStatusResponse, error)
  • func (c *Client) OffsetMediaInputCursor(params *OffsetMediaInputCursorParams) (*OffsetMediaInputCursorResponse, error)
  • func (c *Client) SetMediaInputCursor(params *SetMediaInputCursorParams) (*SetMediaInputCursorResponse, error)
  • func (c *Client) TriggerMediaInputAction(params *TriggerMediaInputActionParams) (*TriggerMediaInputActionResponse, error)
• type GetMediaInputStatusParams
  • func NewGetMediaInputStatusParams() *GetMediaInputStatusParams
  • func (o *GetMediaInputStatusParams) GetRequestName() string
  • func (o *GetMediaInputStatusParams) WithInputName(x string) *GetMediaInputStatusParams
• type GetMediaInputStatusResponse
• type OffsetMediaInputCursorParams
  • func NewOffsetMediaInputCursorParams() *OffsetMediaInputCursorParams
  • func (o *OffsetMediaInputCursorParams) GetRequestName() string
  • func (o *OffsetMediaInputCursorParams) WithInputName(x string) *OffsetMediaInputCursorParams
  • func (o *OffsetMediaInputCursorParams) WithMediaCursorOffset(x float64) *OffsetMediaInputCursorParams
• type OffsetMediaInputCursorResponse
• type SetMediaInputCursorParams
  • func NewSetMediaInputCursorParams() *SetMediaInputCursorParams
  • func (o *SetMediaInputCursorParams) GetRequestName() string
  • func (o *SetMediaInputCursorParams) WithInputName(x string) *SetMediaInputCursorParams
  • func (o *SetMediaInputCursorParams) WithMediaCursor(x float64) *SetMediaInputCursorParams
• type SetMediaInputCursorResponse
• type TriggerMediaInputActionParams
  • func NewTriggerMediaInputActionParams() *TriggerMediaInputActionParams
  • func (o *TriggerMediaInputActionParams) GetRequestName() string
  • func (o *TriggerMediaInputActionParams) WithInputName(x string) *TriggerMediaInputActionParams
  • func (o *TriggerMediaInputActionParams) WithMediaAction(x string) *TriggerMediaInputActionParams
• type TriggerMediaInputActionResponse

Types

type Client

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

Client represents a client for 'media inputs' requests.

func NewClient

func NewClient(c *api.Client) *Client

NewMediaInputs returns a new 'media inputs' client.

func (*Client) GetMediaInputStatus

func (c *Client) GetMediaInputStatus(params *GetMediaInputStatusParams) (*GetMediaInputStatusResponse, error)

Gets the status of a media input.

Media States:

- `OBS_MEDIA_STATE_NONE` - `OBS_MEDIA_STATE_PLAYING` - `OBS_MEDIA_STATE_OPENING` - `OBS_MEDIA_STATE_BUFFERING` - `OBS_MEDIA_STATE_PAUSED` - `OBS_MEDIA_STATE_STOPPED` - `OBS_MEDIA_STATE_ENDED` - `OBS_MEDIA_STATE_ERROR`

func (*Client) OffsetMediaInputCursor

func (c *Client) OffsetMediaInputCursor(params *OffsetMediaInputCursorParams) (*OffsetMediaInputCursorResponse, error)

Offsets the current cursor position of a media input by the specified value.

This request does not perform bounds checking of the cursor position.

func (*Client) SetMediaInputCursor

func (c *Client) SetMediaInputCursor(params *SetMediaInputCursorParams) (*SetMediaInputCursorResponse, error)

Sets the cursor position of a media input.

This request does not perform bounds checking of the cursor position.

func (*Client) TriggerMediaInputAction

func (c *Client) TriggerMediaInputAction(
	params *TriggerMediaInputActionParams,
) (*TriggerMediaInputActionResponse, error)

Triggers an action on a media input.

type GetMediaInputStatusParams

type GetMediaInputStatusParams struct {
	// Name of the media input
	InputName *string `json:"inputName,omitempty"`
}

Represents the request body for the GetMediaInputStatus request.

func NewGetMediaInputStatusParams

func NewGetMediaInputStatusParams() *GetMediaInputStatusParams

func (*GetMediaInputStatusParams) GetRequestName

func (o *GetMediaInputStatusParams) GetRequestName() string

Returns the associated request.

func (*GetMediaInputStatusParams) WithInputName

func (o *GetMediaInputStatusParams) WithInputName(x string) *GetMediaInputStatusParams

type GetMediaInputStatusResponse

type GetMediaInputStatusResponse struct {

	// Position of the cursor in milliseconds. `null` if not playing
	MediaCursor float64 `json:"mediaCursor,omitempty"`

	// Total duration of the playing media in milliseconds. `null` if not playing
	MediaDuration float64 `json:"mediaDuration,omitempty"`

	// State of the media input
	MediaState string `json:"mediaState,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetMediaInputStatus request.

type OffsetMediaInputCursorParams

type OffsetMediaInputCursorParams struct {
	// Name of the media input
	InputName *string `json:"inputName,omitempty"`

	// Value to offset the current cursor position by
	MediaCursorOffset *float64 `json:"mediaCursorOffset,omitempty"`
}

Represents the request body for the OffsetMediaInputCursor request.

func NewOffsetMediaInputCursorParams

func NewOffsetMediaInputCursorParams() *OffsetMediaInputCursorParams

func (*OffsetMediaInputCursorParams) GetRequestName

func (o *OffsetMediaInputCursorParams) GetRequestName() string

Returns the associated request.

func (*OffsetMediaInputCursorParams) WithInputName

func (o *OffsetMediaInputCursorParams) WithInputName(x string) *OffsetMediaInputCursorParams

func (*OffsetMediaInputCursorParams) WithMediaCursorOffset

func (o *OffsetMediaInputCursorParams) WithMediaCursorOffset(x float64) *OffsetMediaInputCursorParams

type OffsetMediaInputCursorResponse

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

Represents the response body for the OffsetMediaInputCursor request.

type SetMediaInputCursorParams

type SetMediaInputCursorParams struct {
	// Name of the media input
	InputName *string `json:"inputName,omitempty"`

	// New cursor position to set
	MediaCursor *float64 `json:"mediaCursor,omitempty"`
}

Represents the request body for the SetMediaInputCursor request.

func NewSetMediaInputCursorParams

func NewSetMediaInputCursorParams() *SetMediaInputCursorParams

func (*SetMediaInputCursorParams) GetRequestName

func (o *SetMediaInputCursorParams) GetRequestName() string

Returns the associated request.

func (*SetMediaInputCursorParams) WithInputName

func (o *SetMediaInputCursorParams) WithInputName(x string) *SetMediaInputCursorParams

func (*SetMediaInputCursorParams) WithMediaCursor

func (o *SetMediaInputCursorParams) WithMediaCursor(x float64) *SetMediaInputCursorParams

type SetMediaInputCursorResponse

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

Represents the response body for the SetMediaInputCursor request.

type TriggerMediaInputActionParams

type TriggerMediaInputActionParams struct {
	// Name of the media input
	InputName *string `json:"inputName,omitempty"`

	// Identifier of the `ObsMediaInputAction` enum
	MediaAction *string `json:"mediaAction,omitempty"`
}

Represents the request body for the TriggerMediaInputAction request.

func NewTriggerMediaInputActionParams

func NewTriggerMediaInputActionParams() *TriggerMediaInputActionParams

func (*TriggerMediaInputActionParams) GetRequestName

func (o *TriggerMediaInputActionParams) GetRequestName() string

Returns the associated request.

func (*TriggerMediaInputActionParams) WithInputName

func (o *TriggerMediaInputActionParams) WithInputName(x string) *TriggerMediaInputActionParams

func (*TriggerMediaInputActionParams) WithMediaAction

func (o *TriggerMediaInputActionParams) WithMediaAction(x string) *TriggerMediaInputActionParams

type TriggerMediaInputActionResponse

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

Represents the response body for the TriggerMediaInputAction request.