Documentation ¶
Overview ¶
Package media provides the Chrome DevTools Protocol commands, types, and events for the Media domain.
This domain allows detailed inspection of media elements.
Generated by the cdproto-gen command.
Index ¶
- Constants
- type DisableParams
- type EnableParams
- type EventPlayerErrorsRaised
- type EventPlayerEventsAdded
- type EventPlayerMessagesLogged
- type EventPlayerPropertiesChanged
- type EventPlayersCreated
- type PlayerError
- type PlayerErrorType
- type PlayerEvent
- type PlayerID
- type PlayerMessage
- type PlayerMessageLevel
- type PlayerProperty
- type Timestamp
Constants ¶
const ( CommandEnable = "Media.enable" CommandDisable = "Media.disable" )
Command names.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DisableParams ¶
type DisableParams struct{}
DisableParams disables the Media domain.
func Disable ¶
func Disable() *DisableParams
Disable disables the Media domain.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#method-disable
func (*DisableParams) Do ¶
func (p *DisableParams) Do(ctx context.Context) (err error)
Do executes Media.disable against the provided context.
func (DisableParams) MarshalEasyJSON ¶
func (v DisableParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (DisableParams) MarshalJSON ¶
func (v DisableParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*DisableParams) UnmarshalEasyJSON ¶
func (v *DisableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DisableParams) UnmarshalJSON ¶
func (v *DisableParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type EnableParams ¶
type EnableParams struct{}
EnableParams enables the Media domain.
func Enable ¶
func Enable() *EnableParams
Enable enables the Media domain.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#method-enable
func (*EnableParams) Do ¶
func (p *EnableParams) Do(ctx context.Context) (err error)
Do executes Media.enable against the provided context.
func (EnableParams) MarshalEasyJSON ¶
func (v EnableParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (EnableParams) MarshalJSON ¶
func (v EnableParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*EnableParams) UnmarshalEasyJSON ¶
func (v *EnableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*EnableParams) UnmarshalJSON ¶
func (v *EnableParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type EventPlayerErrorsRaised ¶
type EventPlayerErrorsRaised struct { PlayerID PlayerID `json:"playerId"` Errors []*PlayerError `json:"errors"` }
EventPlayerErrorsRaised send a list of any errors that need to be delivered.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#event-playerErrorsRaised
func (EventPlayerErrorsRaised) MarshalEasyJSON ¶
func (v EventPlayerErrorsRaised) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (EventPlayerErrorsRaised) MarshalJSON ¶
func (v EventPlayerErrorsRaised) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*EventPlayerErrorsRaised) UnmarshalEasyJSON ¶
func (v *EventPlayerErrorsRaised) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*EventPlayerErrorsRaised) UnmarshalJSON ¶
func (v *EventPlayerErrorsRaised) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type EventPlayerEventsAdded ¶
type EventPlayerEventsAdded struct { PlayerID PlayerID `json:"playerId"` Events []*PlayerEvent `json:"events"` }
EventPlayerEventsAdded send events as a list, allowing them to be batched on the browser for less congestion. If batched, events must ALWAYS be in chronological order.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#event-playerEventsAdded
func (EventPlayerEventsAdded) MarshalEasyJSON ¶
func (v EventPlayerEventsAdded) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (EventPlayerEventsAdded) MarshalJSON ¶
func (v EventPlayerEventsAdded) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*EventPlayerEventsAdded) UnmarshalEasyJSON ¶
func (v *EventPlayerEventsAdded) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*EventPlayerEventsAdded) UnmarshalJSON ¶
func (v *EventPlayerEventsAdded) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type EventPlayerMessagesLogged ¶
type EventPlayerMessagesLogged struct { PlayerID PlayerID `json:"playerId"` Messages []*PlayerMessage `json:"messages"` }
EventPlayerMessagesLogged send a list of any messages that need to be delivered.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#event-playerMessagesLogged
func (EventPlayerMessagesLogged) MarshalEasyJSON ¶
func (v EventPlayerMessagesLogged) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (EventPlayerMessagesLogged) MarshalJSON ¶
func (v EventPlayerMessagesLogged) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*EventPlayerMessagesLogged) UnmarshalEasyJSON ¶
func (v *EventPlayerMessagesLogged) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*EventPlayerMessagesLogged) UnmarshalJSON ¶
func (v *EventPlayerMessagesLogged) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type EventPlayerPropertiesChanged ¶
type EventPlayerPropertiesChanged struct { PlayerID PlayerID `json:"playerId"` Properties []*PlayerProperty `json:"properties"` }
EventPlayerPropertiesChanged this can be called multiple times, and can be used to set / override / remove player properties. A null propValue indicates removal.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#event-playerPropertiesChanged
func (EventPlayerPropertiesChanged) MarshalEasyJSON ¶
func (v EventPlayerPropertiesChanged) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (EventPlayerPropertiesChanged) MarshalJSON ¶
func (v EventPlayerPropertiesChanged) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*EventPlayerPropertiesChanged) UnmarshalEasyJSON ¶
func (v *EventPlayerPropertiesChanged) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*EventPlayerPropertiesChanged) UnmarshalJSON ¶
func (v *EventPlayerPropertiesChanged) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type EventPlayersCreated ¶
type EventPlayersCreated struct {
Players []PlayerID `json:"players"`
}
EventPlayersCreated called whenever a player is created, or when a new agent joins and receives a list of active players. If an agent is restored, it will receive the full list of player ids and all events again.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#event-playersCreated
func (EventPlayersCreated) MarshalEasyJSON ¶
func (v EventPlayersCreated) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (EventPlayersCreated) MarshalJSON ¶
func (v EventPlayersCreated) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*EventPlayersCreated) UnmarshalEasyJSON ¶
func (v *EventPlayersCreated) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*EventPlayersCreated) UnmarshalJSON ¶
func (v *EventPlayersCreated) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type PlayerError ¶
type PlayerError struct { Type PlayerErrorType `json:"type"` ErrorCode string `json:"errorCode"` // When this switches to using media::Status instead of PipelineStatus we can remove "errorCode" and replace it with the fields from a Status instance. This also seems like a duplicate of the error level enum - there is a todo bug to have that level removed and use this instead. (crbug.com/1068454) }
PlayerError corresponds to kMediaError.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#type-PlayerError
func (PlayerError) MarshalEasyJSON ¶
func (v PlayerError) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (PlayerError) MarshalJSON ¶
func (v PlayerError) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*PlayerError) UnmarshalEasyJSON ¶
func (v *PlayerError) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*PlayerError) UnmarshalJSON ¶
func (v *PlayerError) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type PlayerErrorType ¶
type PlayerErrorType string
PlayerErrorType [no description].
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#type-PlayerError
const ( PlayerErrorTypePipelineError PlayerErrorType = "pipeline_error" PlayerErrorTypeMediaError PlayerErrorType = "media_error" )
PlayerErrorType values.
func (PlayerErrorType) MarshalEasyJSON ¶
func (t PlayerErrorType) MarshalEasyJSON(out *jwriter.Writer)
MarshalEasyJSON satisfies easyjson.Marshaler.
func (PlayerErrorType) MarshalJSON ¶
func (t PlayerErrorType) MarshalJSON() ([]byte, error)
MarshalJSON satisfies json.Marshaler.
func (PlayerErrorType) String ¶
func (t PlayerErrorType) String() string
String returns the PlayerErrorType as string value.
func (*PlayerErrorType) UnmarshalEasyJSON ¶
func (t *PlayerErrorType) UnmarshalEasyJSON(in *jlexer.Lexer)
UnmarshalEasyJSON satisfies easyjson.Unmarshaler.
func (*PlayerErrorType) UnmarshalJSON ¶
func (t *PlayerErrorType) UnmarshalJSON(buf []byte) error
UnmarshalJSON satisfies json.Unmarshaler.
type PlayerEvent ¶
PlayerEvent corresponds to kMediaEventTriggered.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#type-PlayerEvent
func (PlayerEvent) MarshalEasyJSON ¶
func (v PlayerEvent) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (PlayerEvent) MarshalJSON ¶
func (v PlayerEvent) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*PlayerEvent) UnmarshalEasyJSON ¶
func (v *PlayerEvent) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*PlayerEvent) UnmarshalJSON ¶
func (v *PlayerEvent) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type PlayerID ¶
type PlayerID string
PlayerID players will get an ID that is unique within the agent context.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#type-PlayerId
type PlayerMessage ¶
type PlayerMessage struct { Level PlayerMessageLevel `json:"level"` // Keep in sync with MediaLogMessageLevel We are currently keeping the message level 'error' separate from the PlayerError type because right now they represent different things, this one being a DVLOG(ERROR) style log message that gets printed based on what log level is selected in the UI, and the other is a representation of a media::PipelineStatus object. Soon however we're going to be moving away from using PipelineStatus for errors and introducing a new error type which should hopefully let us integrate the error log level into the PlayerError type. Message string `json:"message"` }
PlayerMessage have one type per entry in MediaLogRecord::Type Corresponds to kMessage.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#type-PlayerMessage
func (PlayerMessage) MarshalEasyJSON ¶
func (v PlayerMessage) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (PlayerMessage) MarshalJSON ¶
func (v PlayerMessage) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*PlayerMessage) UnmarshalEasyJSON ¶
func (v *PlayerMessage) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*PlayerMessage) UnmarshalJSON ¶
func (v *PlayerMessage) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type PlayerMessageLevel ¶
type PlayerMessageLevel string
PlayerMessageLevel keep in sync with MediaLogMessageLevel We are currently keeping the message level 'error' separate from the PlayerError type because right now they represent different things, this one being a DVLOG(ERROR) style log message that gets printed based on what log level is selected in the UI, and the other is a representation of a media::PipelineStatus object. Soon however we're going to be moving away from using PipelineStatus for errors and introducing a new error type which should hopefully let us integrate the error log level into the PlayerError type.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#type-PlayerMessage
const ( PlayerMessageLevelError PlayerMessageLevel = "error" PlayerMessageLevelWarning PlayerMessageLevel = "warning" PlayerMessageLevelInfo PlayerMessageLevel = "info" PlayerMessageLevelDebug PlayerMessageLevel = "debug" )
PlayerMessageLevel values.
func (PlayerMessageLevel) MarshalEasyJSON ¶
func (t PlayerMessageLevel) MarshalEasyJSON(out *jwriter.Writer)
MarshalEasyJSON satisfies easyjson.Marshaler.
func (PlayerMessageLevel) MarshalJSON ¶
func (t PlayerMessageLevel) MarshalJSON() ([]byte, error)
MarshalJSON satisfies json.Marshaler.
func (PlayerMessageLevel) String ¶
func (t PlayerMessageLevel) String() string
String returns the PlayerMessageLevel as string value.
func (*PlayerMessageLevel) UnmarshalEasyJSON ¶
func (t *PlayerMessageLevel) UnmarshalEasyJSON(in *jlexer.Lexer)
UnmarshalEasyJSON satisfies easyjson.Unmarshaler.
func (*PlayerMessageLevel) UnmarshalJSON ¶
func (t *PlayerMessageLevel) UnmarshalJSON(buf []byte) error
UnmarshalJSON satisfies json.Unmarshaler.
type PlayerProperty ¶
PlayerProperty corresponds to kMediaPropertyChange.
See: https://chromedevtools.github.io/devtools-protocol/tot/Media#type-PlayerProperty
func (PlayerProperty) MarshalEasyJSON ¶
func (v PlayerProperty) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (PlayerProperty) MarshalJSON ¶
func (v PlayerProperty) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*PlayerProperty) UnmarshalEasyJSON ¶
func (v *PlayerProperty) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*PlayerProperty) UnmarshalJSON ¶
func (v *PlayerProperty) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface