package cast

Import Path
	github.com/chromedp/cdproto/cast (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	  d cast.go
		Package cast provides the Chrome DevTools Protocol
		commands, types, and events for the Cast domain.
		
		A domain for interacting with Cast, Presentation API, and Remote Playback
		API functionalities.
		
		Generated by the cdproto-gen command.

	    easyjson.go
	    events.go
	    types.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type DisableParams (struct)
		DisableParams stops observing for sinks and issues.

		Methods (total 5)
			(*DisableParams) Do(ctx context.Context) (err error)
				Do executes Cast.disable against the provided context.

			( DisableParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( DisableParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*DisableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*DisableParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*DisableParams : github.com/chromedp/chromedp.Action
			*DisableParams : github.com/chromedp/chromedp.CallAction
			*DisableParams : github.com/chromedp/chromedp.EmulateAction
			*DisableParams : github.com/chromedp/chromedp.EvaluateAction
			*DisableParams : github.com/chromedp/chromedp.KeyAction
			*DisableParams : github.com/chromedp/chromedp.MouseAction
			*DisableParams : github.com/chromedp/chromedp.NavigateAction
			*DisableParams : github.com/chromedp/chromedp.PollAction
			*DisableParams : github.com/chromedp/chromedp.QueryAction
			 DisableParams : github.com/goccy/go-json.Marshaler
			*DisableParams : github.com/goccy/go-json.Unmarshaler
			 DisableParams : github.com/mailru/easyjson.Marshaler
			*DisableParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*DisableParams : github.com/mailru/easyjson.Unmarshaler
			 DisableParams : encoding/json.Marshaler
			*DisableParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func Disable() *DisableParams

	 type EnableParams (struct)
		EnableParams starts observing for sinks that can be used for tab
		mirroring, and if set, sinks compatible with |presentationUrl| as well. When
		sinks are found, a |sinksUpdated| event is fired. Also starts observing for
		issue messages. When an issue is added or removed, an |issueUpdated| event is
		fired.

		Fields (only one)
			PresentationURL string
		Methods (total 6)
			(*EnableParams) Do(ctx context.Context) (err error)
				Do executes Cast.enable against the provided context.

			( EnableParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EnableParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EnableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EnableParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

			( EnableParams) WithPresentationURL(presentationURL string) *EnableParams
				WithPresentationURL [no description].

		Implements (at least 16)
			*EnableParams : github.com/chromedp/chromedp.Action
			*EnableParams : github.com/chromedp/chromedp.CallAction
			*EnableParams : github.com/chromedp/chromedp.EmulateAction
			*EnableParams : github.com/chromedp/chromedp.EvaluateAction
			*EnableParams : github.com/chromedp/chromedp.KeyAction
			*EnableParams : github.com/chromedp/chromedp.MouseAction
			*EnableParams : github.com/chromedp/chromedp.NavigateAction
			*EnableParams : github.com/chromedp/chromedp.PollAction
			*EnableParams : github.com/chromedp/chromedp.QueryAction
			 EnableParams : github.com/goccy/go-json.Marshaler
			*EnableParams : github.com/goccy/go-json.Unmarshaler
			 EnableParams : github.com/mailru/easyjson.Marshaler
			*EnableParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EnableParams : github.com/mailru/easyjson.Unmarshaler
			 EnableParams : encoding/json.Marshaler
			*EnableParams : encoding/json.Unmarshaler
		As Outputs Of (at least 2)
			func Enable() *EnableParams
			func EnableParams.WithPresentationURL(presentationURL string) *EnableParams

	 type EventIssueUpdated (struct)
		EventIssueUpdated this is fired whenever the outstanding issue/error
		message changes. |issueMessage| is empty if there is no issue.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#event-issueUpdated

		Fields (only one)
			IssueMessage string
		Methods (total 4)
			( EventIssueUpdated) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EventIssueUpdated) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EventIssueUpdated) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EventIssueUpdated) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 EventIssueUpdated : github.com/goccy/go-json.Marshaler
			*EventIssueUpdated : github.com/goccy/go-json.Unmarshaler
			 EventIssueUpdated : github.com/mailru/easyjson.Marshaler
			*EventIssueUpdated : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EventIssueUpdated : github.com/mailru/easyjson.Unmarshaler
			 EventIssueUpdated : encoding/json.Marshaler
			*EventIssueUpdated : encoding/json.Unmarshaler

	 type EventSinksUpdated (struct)
		EventSinksUpdated this is fired whenever the list of available sinks
		changes. A sink is a device or a software surface that you can cast to.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#event-sinksUpdated

		Fields (only one)
			Sinks []*Sink
		Methods (total 4)
			( EventSinksUpdated) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EventSinksUpdated) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EventSinksUpdated) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EventSinksUpdated) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 EventSinksUpdated : github.com/goccy/go-json.Marshaler
			*EventSinksUpdated : github.com/goccy/go-json.Unmarshaler
			 EventSinksUpdated : github.com/mailru/easyjson.Marshaler
			*EventSinksUpdated : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EventSinksUpdated : github.com/mailru/easyjson.Unmarshaler
			 EventSinksUpdated : encoding/json.Marshaler
			*EventSinksUpdated : encoding/json.Unmarshaler

	 type SetSinkToUseParams (struct)
		SetSinkToUseParams sets a sink to be used when the web page requests the
		browser to choose a sink via Presentation API, Remote Playback API, or Cast
		SDK.

		Fields (only one)
			SinkName string
		Methods (total 5)
			(*SetSinkToUseParams) Do(ctx context.Context) (err error)
				Do executes Cast.setSinkToUse against the provided context.

			( SetSinkToUseParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( SetSinkToUseParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*SetSinkToUseParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*SetSinkToUseParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*SetSinkToUseParams : github.com/chromedp/chromedp.Action
			*SetSinkToUseParams : github.com/chromedp/chromedp.CallAction
			*SetSinkToUseParams : github.com/chromedp/chromedp.EmulateAction
			*SetSinkToUseParams : github.com/chromedp/chromedp.EvaluateAction
			*SetSinkToUseParams : github.com/chromedp/chromedp.KeyAction
			*SetSinkToUseParams : github.com/chromedp/chromedp.MouseAction
			*SetSinkToUseParams : github.com/chromedp/chromedp.NavigateAction
			*SetSinkToUseParams : github.com/chromedp/chromedp.PollAction
			*SetSinkToUseParams : github.com/chromedp/chromedp.QueryAction
			 SetSinkToUseParams : github.com/goccy/go-json.Marshaler
			*SetSinkToUseParams : github.com/goccy/go-json.Unmarshaler
			 SetSinkToUseParams : github.com/mailru/easyjson.Marshaler
			*SetSinkToUseParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*SetSinkToUseParams : github.com/mailru/easyjson.Unmarshaler
			 SetSinkToUseParams : encoding/json.Marshaler
			*SetSinkToUseParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func SetSinkToUse(sinkName string) *SetSinkToUseParams

	 type Sink (struct)
		Sink [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#type-Sink

		Fields (total 3)
			ID string
			Name string
			Session string
				// Text describing the current session. Present only if there is an active session on the sink.

		Methods (total 4)
			( Sink) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( Sink) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*Sink) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*Sink) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 Sink : github.com/goccy/go-json.Marshaler
			*Sink : github.com/goccy/go-json.Unmarshaler
			 Sink : github.com/mailru/easyjson.Marshaler
			*Sink : github.com/mailru/easyjson.MarshalerUnmarshaler
			*Sink : github.com/mailru/easyjson.Unmarshaler
			 Sink : encoding/json.Marshaler
			*Sink : encoding/json.Unmarshaler

	 type StartDesktopMirroringParams (struct)
		StartDesktopMirroringParams starts mirroring the desktop to the sink.

		Fields (only one)
			SinkName string
		Methods (total 5)
			(*StartDesktopMirroringParams) Do(ctx context.Context) (err error)
				Do executes Cast.startDesktopMirroring against the provided context.

			( StartDesktopMirroringParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( StartDesktopMirroringParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*StartDesktopMirroringParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*StartDesktopMirroringParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.Action
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.CallAction
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.EmulateAction
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.EvaluateAction
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.KeyAction
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.MouseAction
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.NavigateAction
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.PollAction
			*StartDesktopMirroringParams : github.com/chromedp/chromedp.QueryAction
			 StartDesktopMirroringParams : github.com/goccy/go-json.Marshaler
			*StartDesktopMirroringParams : github.com/goccy/go-json.Unmarshaler
			 StartDesktopMirroringParams : github.com/mailru/easyjson.Marshaler
			*StartDesktopMirroringParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*StartDesktopMirroringParams : github.com/mailru/easyjson.Unmarshaler
			 StartDesktopMirroringParams : encoding/json.Marshaler
			*StartDesktopMirroringParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func StartDesktopMirroring(sinkName string) *StartDesktopMirroringParams

	 type StartTabMirroringParams (struct)
		StartTabMirroringParams starts mirroring the tab to the sink.

		Fields (only one)
			SinkName string
		Methods (total 5)
			(*StartTabMirroringParams) Do(ctx context.Context) (err error)
				Do executes Cast.startTabMirroring against the provided context.

			( StartTabMirroringParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( StartTabMirroringParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*StartTabMirroringParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*StartTabMirroringParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*StartTabMirroringParams : github.com/chromedp/chromedp.Action
			*StartTabMirroringParams : github.com/chromedp/chromedp.CallAction
			*StartTabMirroringParams : github.com/chromedp/chromedp.EmulateAction
			*StartTabMirroringParams : github.com/chromedp/chromedp.EvaluateAction
			*StartTabMirroringParams : github.com/chromedp/chromedp.KeyAction
			*StartTabMirroringParams : github.com/chromedp/chromedp.MouseAction
			*StartTabMirroringParams : github.com/chromedp/chromedp.NavigateAction
			*StartTabMirroringParams : github.com/chromedp/chromedp.PollAction
			*StartTabMirroringParams : github.com/chromedp/chromedp.QueryAction
			 StartTabMirroringParams : github.com/goccy/go-json.Marshaler
			*StartTabMirroringParams : github.com/goccy/go-json.Unmarshaler
			 StartTabMirroringParams : github.com/mailru/easyjson.Marshaler
			*StartTabMirroringParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*StartTabMirroringParams : github.com/mailru/easyjson.Unmarshaler
			 StartTabMirroringParams : encoding/json.Marshaler
			*StartTabMirroringParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func StartTabMirroring(sinkName string) *StartTabMirroringParams

	 type StopCastingParams (struct)
		StopCastingParams stops the active Cast session on the sink.

		Fields (only one)
			SinkName string
		Methods (total 5)
			(*StopCastingParams) Do(ctx context.Context) (err error)
				Do executes Cast.stopCasting against the provided context.

			( StopCastingParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( StopCastingParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*StopCastingParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*StopCastingParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*StopCastingParams : github.com/chromedp/chromedp.Action
			*StopCastingParams : github.com/chromedp/chromedp.CallAction
			*StopCastingParams : github.com/chromedp/chromedp.EmulateAction
			*StopCastingParams : github.com/chromedp/chromedp.EvaluateAction
			*StopCastingParams : github.com/chromedp/chromedp.KeyAction
			*StopCastingParams : github.com/chromedp/chromedp.MouseAction
			*StopCastingParams : github.com/chromedp/chromedp.NavigateAction
			*StopCastingParams : github.com/chromedp/chromedp.PollAction
			*StopCastingParams : github.com/chromedp/chromedp.QueryAction
			 StopCastingParams : github.com/goccy/go-json.Marshaler
			*StopCastingParams : github.com/goccy/go-json.Unmarshaler
			 StopCastingParams : github.com/mailru/easyjson.Marshaler
			*StopCastingParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*StopCastingParams : github.com/mailru/easyjson.Unmarshaler
			 StopCastingParams : encoding/json.Marshaler
			*StopCastingParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func StopCasting(sinkName string) *StopCastingParams


Package-Level Functions (total 6)

	 func Disable() *DisableParams
		Disable stops observing for sinks and issues.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#method-disable

	 func Enable() *EnableParams
		Enable starts observing for sinks that can be used for tab mirroring, and
		if set, sinks compatible with |presentationUrl| as well. When sinks are
		found, a |sinksUpdated| event is fired. Also starts observing for issue
		messages. When an issue is added or removed, an |issueUpdated| event is
		fired.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#method-enable
		
		parameters:

	 func SetSinkToUse(sinkName string) *SetSinkToUseParams
		SetSinkToUse sets a sink to be used when the web page requests the browser
		to choose a sink via Presentation API, Remote Playback API, or Cast SDK.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#method-setSinkToUse
		
		parameters:
		
			sinkName

	 func StartDesktopMirroring(sinkName string) *StartDesktopMirroringParams
		StartDesktopMirroring starts mirroring the desktop to the sink.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#method-startDesktopMirroring
		
		parameters:
		
			sinkName

	 func StartTabMirroring(sinkName string) *StartTabMirroringParams
		StartTabMirroring starts mirroring the tab to the sink.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#method-startTabMirroring
		
		parameters:
		
			sinkName

	 func StopCasting(sinkName string) *StopCastingParams
		StopCasting stops the active Cast session on the sink.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/Cast#method-stopCasting
		
		parameters:
		
			sinkName


Package-Level Constants (total 6)

	const CommandDisable = "Cast.disable"
		Command names.

	const CommandEnable = "Cast.enable"
		Command names.

	const CommandSetSinkToUse = "Cast.setSinkToUse"
		Command names.

	const CommandStartDesktopMirroring = "Cast.startDesktopMirroring"
		Command names.

	const CommandStartTabMirroring = "Cast.startTabMirroring"
		Command names.

	const CommandStopCasting = "Cast.stopCasting"
		Command names.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.