Struct script::dom::mediasession::MediaSession

#[repr(C)]
pub struct MediaSession {
    reflector_: Reflector,
    metadata: DomRefCell<Option<EmbedderMediaMetadata>>,
    playback_state: DomRefCell<MediaSessionPlaybackState>,
    action_handlers: DomRefCell<HashMap<MediaSessionActionType, Rc<MediaSessionActionHandler>>>,
    media_instance: MutNullableDom<HTMLMediaElement>,
}

Fields

reflector_: Reflector

metadata: DomRefCell<Option<EmbedderMediaMetadata>>

https://w3c.github.io/mediasession/#dom-mediasession-metadata

playback_state: DomRefCell<MediaSessionPlaybackState>

https://w3c.github.io/mediasession/#dom-mediasession-playbackstate

action_handlers: DomRefCell<HashMap<MediaSessionActionType, Rc<MediaSessionActionHandler>>>

https://w3c.github.io/mediasession/#supported-media-session-actions

media_instance: MutNullableDom<HTMLMediaElement>

The media instance controlled by this media session. For now only HTMLMediaElements are controlled by media sessions.

Implementations

impl MediaSession

fn __assert_parent_type(&self)

impl MediaSession

fn new_inherited() -> MediaSession

pub fn new(window: &Window) -> Root<Dom<MediaSession>>

pub fn register_media_instance(&self, media_instance: &HTMLMediaElement)

pub fn handle_action(&self, action: MediaSessionActionType)

pub fn send_event(&self, event: MediaSessionEvent)

pub fn update_title(&self, title: String)

Trait Implementations

impl DomObject for MediaSession

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>where
    Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl DomObjectWrap for MediaSession

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Box<Self>) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::MediaSessionBinding::MediaSessionBinding::Wrap as for<'a> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::boxed::Box<dom::mediasession::MediaSession>) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::mediasession::MediaSession>>}

Function pointer to the general wrap function type

impl HasParent for MediaSession

fn as_parent(&self) -> &Reflector

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = Reflector

impl IDLInterface for MediaSession

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl JSTraceable for MediaSession

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl MallocSizeOf for MediaSession

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MediaSessionMethods for MediaSession

fn GetMetadata(&self) -> Option<Root<Dom<MediaMetadata>>>

https://w3c.github.io/mediasession/#dom-mediasession-metadata

fn SetMetadata(&self, metadata: Option<&MediaMetadata>)

https://w3c.github.io/mediasession/#dom-mediasession-metadata

fn PlaybackState(&self) -> MediaSessionPlaybackState

https://w3c.github.io/mediasession/#dom-mediasession-playbackstate

fn SetPlaybackState(&self, state: MediaSessionPlaybackState)

https://w3c.github.io/mediasession/#dom-mediasession-playbackstate

fn SetActionHandler(
    &self,
    action: MediaSessionAction,
    handler: Option<Rc<MediaSessionActionHandler>>
)

https://w3c.github.io/mediasession/#update-action-handler-algorithm

fn SetPositionState(&self, state: &MediaPositionState) -> Result<(), Error>

https://w3c.github.io/mediasession/#dom-mediasession-setpositionstate

impl MutDomObject for MediaSession

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq<MediaSession> for MediaSession

fn eq(&self, other: &MediaSession) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToJSValConvertible for MediaSession

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.