VideoPlayerPlatform class abstract
The interface that implementations of video_player must implement.
Platform implementations should extend this class rather than implement it as video_player
does not consider newly added methods to be breaking changes. Extending this class
(using extends) ensures that the subclass will get the default implementation, while
platform implementations that implements this interface will be broken by newly added
VideoPlayerPlatform methods.
- Inheritance
-
- Object
- PlatformInterface
- VideoPlayerPlatform
Constructors
- VideoPlayerPlatform()
- Constructs a VideoPlayerPlatform.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
buildView(
int playerId) → Widget - Returns a widget displaying the video with a given playerId.
-
create(
DataSource dataSource) → Future< int?> - Creates an instance of a video player and returns its playerId.
-
dispose(
int playerId) → Future< void> - Clears one video.
-
getActiveTrackInfo(
int playerId) → Future< List< Track> > - Get activated(selected) track infomation of the associated media.
-
getAudioTracks(
int playerId) → Future< List< AudioTrack> > - Gets the audio tracks as a list of AudioTrack.
-
getData(
int playerId, Set< DashPlayerProperty> keys) → Future<Map< DashPlayerProperty, Object> > - Get dashplayer properties.
-
getDuration(
int playerId) → Future< DurationRange> - Gets the video duration as DurationRange.
-
getPosition(
int playerId) → Future< Duration> - Gets the video position as Duration from the start.
-
getStreamingProperty(
int playerId, StreamingPropertyType type) → Future< String> - Retrieves a specific property value obtained by the streaming engine (Smooth Streaming, HLS, DASH, or Widevine).
-
getTextTracks(
int playerId) → Future< List< TextTrack> > - Gets the text tracks as a list of TextTrack.
-
getVideoTracks(
int playerId) → Future< List< VideoTrack> > - Gets the video tracks as a list of VideoTrack.
-
init(
) → Future< void> - Initializes the platform interface and disposes all existing players.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
int playerId) → Future< void> - Stops the video playback.
-
play(
int playerId) → Future< void> - Starts the video playback.
-
restore(
int playerId, {DataSource? dataSource, int resumeTime = -1}) → Future< void> - Restores the player state when the application is resumed.
-
seekTo(
int playerId, Duration position) → Future< void> - Sets the video position to a Duration from the start.
-
setActivate(
int playerId) → Future< bool> - Set the video activated.
-
setBufferConfig(
int playerId, BufferConfigType type, int value) → Future< bool> - Sets the buffer size for the player.
-
setData(
int playerId, Map< DashPlayerProperty, Object> data) → Future<bool> - Set dashplayer properties.
-
setDeactivate(
int playerId) → Future< bool> - Set the video deactivated.
-
setDisplayGeometry(
int playerId, int x, int y, int width, int height) → Future< void> - Sets the video display geometry.
-
setDisplayMode(
int playerId, DisplayMode displayMode) → Future< bool> - Set the video display mode.
-
setDisplayRotate(
int playerId, DisplayRotation rotation) → Future< bool> - Set the rotate angle of display.
-
setLooping(
int playerId, bool looping) → Future< void> - Sets the looping attribute of the video.
-
setMixWithOthers(
bool mixWithOthers) → Future< void> - Sets the audio mode to mix with other sources.
-
setPlaybackSpeed(
int playerId, double speed) → Future< void> -
Sets the playback speed to a
speedvalue indicating the playback rate. -
setStreamingProperty(
int playerId, StreamingPropertyType type, String value) → Future< void> - Set streamingengine property.
-
setTrackSelection(
int playerId, Track track) → Future< bool> - Sets the selected track.
-
setVolume(
int playerId, double volume) → Future< void> - Sets the volume to a range between 0.0 and 1.0.
-
suspend(
int playerId) → Future< void> - Pauses the player when the application is sent to the background.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateDashToken(
int playerId, String dashToken) → Future< bool> - Update token.
-
videoEventsFor(
int playerId) → Stream< VideoEvent> - Returns a Stream of VideoEventTypes.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance ↔ VideoPlayerPlatform
-
The default instance of VideoPlayerPlatform to use.
getter/setter pair