blob: f13a0dc336708b4ad47a17e92f62d9e2b773bc98 [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
module media.mojom;
import "media/mojo/interfaces/demuxer_stream.mojom";
import "media/mojo/interfaces/media_types.mojom";
import "mojo/public/mojom/base/time.mojom";
import "mojo/public/mojom/base/unguessable_token.mojom";
import "ui/gfx/geometry/mojo/geometry.mojom";
import "url/mojom/url.mojom";
interface Renderer {
// Initializes the Renderer with either one or more audio / video |streams|,
// or a |media_url| executing the callback with whether the initialization
// succeeded.
Initialize(associated RendererClient client,
array<DemuxerStream>? streams,
url.mojom.Url? media_url,
url.mojom.Url? first_party_for_cookies, bool allow_credentials)
=> (bool success);
// Discards any buffered data, executing callback when completed.
// NOTE: If an error occurs, RendererClient::OnError() can be called
// before the callback is executed.
Flush() => ();
// Starts rendering from |time|.
StartPlayingFrom(mojo_base.mojom.TimeDelta time);
// Updates the current playback rate. The default playback rate should be 1.
SetPlaybackRate(double playback_rate);
// Sets the output volume. The default volume should be 1.
SetVolume(float volume);
// Attaches the CDM associated with |cdm_id| to the renderer service,
// executing the callback with whether the CDM was successfully attached.
SetCdm(int32 cdm_id) => (bool success);
// Registers a new request in the ScopedSurfaceRequestManager, and returns
// its token.
//
// NOTE: Should only be called on Android. Only used for WMPI's fallback path
// (i.e. HLS playback), when the MojoRendererService wraps a
// content::MediaPlayerRenderer.
// Unexpected calls to this method will close the connection.
InitiateScopedSurfaceRequest()
=> (mojo_base.mojom.UnguessableToken request_token);
};
interface RendererClient {
// Called to report media time advancement by |time|.
// |time| and |max_time| can be used to interpolate time between
// calls to OnTimeUpdate().
// |max_time| is typically the media timestamp of the last audio frame
// buffered by the audio hardware.
// |capture_time| is monotonic clock time at which the times were captured.
// |max_time| must be greater or equal to |time|.
OnTimeUpdate(mojo_base.mojom.TimeDelta time,
mojo_base.mojom.TimeDelta max_time,
mojo_base.mojom.TimeTicks capture_time);
// Called to report buffering state changes, see media_types.mojom.
OnBufferingStateChange(BufferingState state);
// Executed when rendering has reached the end of stream.
OnEnded();
// Executed if any error was encountered during decode or rendering. If
// this error happens during an operation that has a completion callback,
// OnError() will be called before firing the completion callback.
OnError();
// Executed whenever DemuxerStream status returns kConfigChange. Initial
// configs provided by OnMetadata.
OnAudioConfigChange(AudioDecoderConfig config);
OnVideoConfigChange(VideoDecoderConfig config);
// Executed for the first video frame and whenever natural size changes.
OnVideoNaturalSizeChange(gfx.mojom.Size size);
// Executed for the first video frame and whenever opacity changes.
OnVideoOpacityChange(bool opaque);
// Called periodically to pass statistics to the web player. See
// media_types.mojom.
OnStatisticsUpdate(PipelineStatistics stats);
// Called when the remote renderering service is waiting for |reason|,
// e.g. waiting for decryption key.
OnWaiting(WaitingReason reason);
// Executed the first time the metadata is updated, and whenever the duration
// changes.
OnDurationChange(mojo_base.mojom.TimeDelta duration);
// Executed whenever a renderer receives notification of a status change that
// was not originated by its owner.
// Only used with the FlingingRenderer (when external devices play/pause the
// video playing remotely).
OnRemotePlayStateChange(MediaStatusState state);
};