public abstract class BaseMediaPlayer : IMediaPlayer, IMediaControl, IMediaInfo, IMediaCache, ITextureProducer, IMediaSubtitles, IVideoTracks, IAudioTracks, ITextTracks, IVariants, IDisposable

Constructors

BaseMediaPlayer()

Declaration

public BaseMediaPlayer()

Properties

Count

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Current

Declaration

public Variant Current { get; }

Property Value

Type	Description
Variant

Item[Int32]

Declaration

public Variant this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type	Description
Variant

Methods

AddChunkToMediaBuffer(Byte[], UInt64, UInt64)

Declaration

public virtual bool AddChunkToMediaBuffer(byte[] chunk, ulong offset, ulong length)

Parameters

Type	Name	Description
System.Byte[]	chunk
System.UInt64	offset
System.UInt64	length

Returns

Type	Description
System.Boolean

AddMediaToCache(String, String, MediaCachingOptions)

Cache the media specified by url.

Declaration

public virtual void AddMediaToCache(string url, string headers, MediaCachingOptions options)

Parameters

Type	Name	Description
System.String	url	The url of the media.
System.String	headers
MediaCachingOptions	options

ApplyTextureProperties(Texture)

Declaration

protected virtual void ApplyTextureProperties(Texture texture)

Parameters

Type	Name	Description
Texture	texture

AudioConfigurationChanged(Boolean)

Declaration

public virtual void AudioConfigurationChanged(bool deviceChanged)

Parameters

Type	Name	Description
System.Boolean	deviceChanged

BeginRender()

Declaration

public virtual void BeginRender()

CancelDownloadOfMediaToCache(String)

Cancels the download of the media specified by url.

Declaration

public virtual void CancelDownloadOfMediaToCache(string url)

Parameters

Type	Name	Description
System.String	url	The url of the media.

CanPlay()

Declaration

public abstract bool CanPlay()

Returns

Type	Description
System.Boolean

CloseMedia()

Declaration

public virtual void CloseMedia()

Dispose()

Declaration

public abstract void Dispose()

EndOpenMediaFromBuffer()

Declaration

public virtual bool EndOpenMediaFromBuffer()

Returns

Type	Description
System.Boolean

EndUpdate()

Declaration

public virtual void EndUpdate()

GetActiveAudioTrack()

Declaration

public AudioTrack GetActiveAudioTrack()

Returns

Type	Description
AudioTrack

GetActiveTextTrack()

Declaration

public TextTrack GetActiveTextTrack()

Returns

Type	Description
TextTrack

GetActiveVideoTrack()

Declaration

public VideoTrack GetActiveVideoTrack()

Returns

Type	Description
VideoTrack

GetAffineTransform()

The affine transform of the texture as an array of six floats: [a, b, c, d, tx, ty].

Declaration

public virtual float[] GetAffineTransform()

Returns

Type	Description
System.Single[]

GetAudioBufferedSampleCount()

Declaration

public virtual int GetAudioBufferedSampleCount()

Returns

Type	Description
System.Int32

GetAudioChannelCount()

Declaration

public virtual int GetAudioChannelCount()

Returns

Type	Description
System.Int32

GetAudioChannelMask()

Declaration

public virtual AudioChannelMaskFlags GetAudioChannelMask()

Returns

Type	Description
AudioChannelMaskFlags

GetAudioTracks()

Declaration

public AudioTracks GetAudioTracks()

Returns

Type	Description
AudioTracks

GetBalance()

Declaration

public virtual float GetBalance()

Returns

Type	Description
System.Single

GetBufferedTimes()

Declaration

public TimeRanges GetBufferedTimes()

Returns

Type	Description
TimeRanges

GetCachedMediaStatus(String, ref Single)

Get the cached status for the media specified.

Declaration

public virtual CachedMediaStatus GetCachedMediaStatus(string url, ref float progress)

Parameters

Type	Name	Description
System.String	url	The url of the media.
System.Single	progress	The amount of the media that has been cached in the range [0...1].

Returns

Type	Description
CachedMediaStatus	The status of the media.

GetCompatibleRenderTextureFormat(GetCompatibleRenderTextureFormatOptions, Int32)

Get a render texture format that is compatible with the textures internal format

Declaration

public virtual RenderTextureFormat GetCompatibleRenderTextureFormat(GetCompatibleRenderTextureFormatOptions options, int plane)

Parameters

Type	Name	Description
GetCompatibleRenderTextureFormatOptions	options	Any options that may change the choice of render texture format, defaults to None
System.Int32	plane	Index of the plane to get compatible render texture format for, defaults to the first plane

Returns

Type	Description
RenderTextureFormat	A compatible render texture format

GetCurrentTextCue()

Declaration

public TextCue GetCurrentTextCue()

Returns

Type	Description
TextCue

GetCurrentTime()

Returns the current video time in seconds

Declaration

public abstract double GetCurrentTime()

Returns

Type	Description
System.Double

GetCurrentTimeFrames(Single)

Returns the current video time in frames, range is [0, GetMaxFrameNumber()] NOTE: For best results the video should be encoded as keyframes only and have no audio track, or an audio track with the same length as the video track

Declaration

public int GetCurrentTimeFrames(float overrideFrameRate = 0F)

Parameters

Type	Name	Description
System.Single	overrideFrameRate

Returns

Type	Description
System.Int32

GetDecoderPerformance(ref Int32, ref Int32, ref Int32)

Declaration

public virtual bool GetDecoderPerformance(ref int activeDecodeThreadCount, ref int decodedFrameCount, ref int droppedFrameCount)

Parameters

Type	Name	Description
System.Int32	activeDecodeThreadCount
System.Int32	decodedFrameCount
System.Int32	droppedFrameCount

Returns

Type	Description
System.Boolean

GetDuration()

Returns media duration in seconds

Declaration

public abstract double GetDuration()

Returns

Type	Description
System.Double

GetDurationFrames(Single)

Returns media duration in frames NOTE: For best results the video should be encoded as keyframes only and have no audio track, or an audio track with the same length as the video track

Declaration

public int GetDurationFrames(float overrideFrameRate = 0F)

Parameters

Type	Name	Description
System.Single	overrideFrameRate

Returns

Type	Description
System.Int32

GetEnumerator()

Declaration

public virtual IEnumerator GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator

GetEstimatedTotalBandwidthUsed()

Gets the estimated bandwidth used by all video players (in bits per second) Currently only supported on Android when using ExoPlayer API

Declaration

public virtual long GetEstimatedTotalBandwidthUsed()

Returns

Type	Description
System.Int64

GetExpectedVersion()

Declaration

public abstract string GetExpectedVersion()

Returns

Type	Description
System.String

GetLastError()

Declaration

public ErrorCode GetLastError()

Returns

Type	Description
ErrorCode

GetLastExtendedErrorCode()

Declaration

public virtual long GetLastExtendedErrorCode()

Returns

Type	Description
System.Int64

GetMaxFrameNumber(Single)

Returns highest frame number that can be seeked to NOTE: For best results the video should be encoded as keyframes only and have no audio track, or an audio track with the same length as the video track

Declaration

public int GetMaxFrameNumber(float overrideFrameRate = 0F)

Parameters

Type	Name	Description
System.Single	overrideFrameRate

Returns

Type	Description
System.Int32

GetNativePlayerHandle()

Declaration

public virtual IntPtr GetNativePlayerHandle()

Returns

Type	Description
IntPtr

GetPlaybackQualityStats()

Declaration

public PlaybackQualityStats GetPlaybackQualityStats()

Returns

Type	Description
PlaybackQualityStats

GetPlaybackRate()

Declaration

public abstract float GetPlaybackRate()

Returns

Type	Description
System.Single

GetPlayerDescription()

Declaration

public string GetPlayerDescription()

Returns

Type	Description
System.String

GetProgramDateTime()

Declaration

public virtual DateTime GetProgramDateTime()

Returns

Type	Description
DateTime

GetSeekableTimes()

Declaration

public TimeRanges GetSeekableTimes()

Returns

Type	Description
TimeRanges

GetSelectedVariant()

Declaration

public virtual Variant GetSelectedVariant()

Returns

Type	Description
Variant

GetSubtitleIndex()

Declaration

public virtual int GetSubtitleIndex()

Returns

Type	Description
System.Int32

GetSubtitleText()

Declaration

public virtual string GetSubtitleText()

Returns

Type	Description
System.String

GetTextTrackArrayIndexFromUid(Int32)

Declaration

public int GetTextTrackArrayIndexFromUid(int Uid)

Parameters

Type	Name	Description
System.Int32	Uid

Returns

Type	Description
System.Int32

GetTextTracks()

Declaration

public TextTracks GetTextTracks()

Returns

Type	Description
TextTracks

GetTexture(Int32)

Returns the Unity texture containing the current frame image. The texture pointer will return null while the video is loading This texture usually remains the same for the duration of the video. There are cases when this texture can change, for instance: if the graphics device is recreated, a new video is loaded, or if an adaptive stream (eg HLS) is used and it switches video streams.

Declaration

public abstract Texture GetTexture(int index = 0)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
Texture

GetTextureAlphaPacking()

Declaration

public AlphaPacking GetTextureAlphaPacking()

Returns

Type	Description
AlphaPacking

GetTextureCount()

Gets the number of textures produced by the media player.

Declaration

public virtual int GetTextureCount()

Returns

Type	Description
System.Int32

GetTextureFrameCount()

Returns a count of how many times the texture has been updated

Declaration

public abstract int GetTextureFrameCount()

Returns

Type	Description
System.Int32

GetTextureMatrix()

The full 4x4 transform of the texture

Declaration

public virtual Matrix4x4 GetTextureMatrix()

Returns

Type	Description
Matrix4x4

GetTexturePixelAspectRatio()

Returns the DAR/SAR ratio

Declaration

public virtual float GetTexturePixelAspectRatio()

Returns

Type	Description
System.Single

GetTextureProperties(out FilterMode, out TextureWrapMode, out Int32)

Declaration

public void GetTextureProperties(out FilterMode filterMode, out TextureWrapMode wrapMode, out int anisoLevel)

Parameters

Type	Name	Description
FilterMode	filterMode
TextureWrapMode	wrapMode
System.Int32	anisoLevel

GetTextureStereoPacking()

Declaration

public StereoPacking GetTextureStereoPacking()

Returns

Type	Description
StereoPacking

GetTextureTimeStamp()

Returns the presentation time stamp of the current texture

Declaration

public virtual long GetTextureTimeStamp()

Returns

Type	Description
System.Int64

GetTextureTransform()

The affine transform of the texture as an array of six floats: a, b, c, d, tx, ty.

Declaration

public virtual float[] GetTextureTransform()

Returns

Type	Description
System.Single[]

GetTextureTransparency()

Declaration

public virtual TransparencyMode GetTextureTransparency()

Returns

Type	Description
TransparencyMode

GetVersion()

Declaration

public abstract string GetVersion()

Returns

Type	Description
System.String

GetVideoDisplayRate()

Returns the current achieved display rate in frames per second

Declaration

public virtual float GetVideoDisplayRate()

Returns

Type	Description
System.Single

GetVideoFrameRate()

Returns the frame rate of the media.

Declaration

public abstract float GetVideoFrameRate()

Returns

Type	Description
System.Single

GetVideoHeight()

Returns video height in pixels

Declaration

public abstract int GetVideoHeight()

Returns

Type	Description
System.Int32

GetVideoTracks()

Declaration

public VideoTracks GetVideoTracks()

Returns

Type	Description
VideoTracks

GetVideoWidth()

Returns video width in pixels

Declaration

public abstract int GetVideoWidth()

Returns

Type	Description
System.Int32

GetVolume()

Declaration

public abstract float GetVolume()

Returns

Type	Description
System.Single

GetYpCbCrTransform()

Returns the current transformation required to convert from YpCbCr to RGB colorspaces.

Declaration

public virtual Matrix4x4 GetYpCbCrTransform()

Returns

Type	Description
Matrix4x4

GrabAudio(Single[], Int32, Int32)

Copies the specified amount of audio into the buffer If the specified amount is not yet available then nothing no samples are copied The number of audio samples grabbed are returned

Declaration

public virtual int GrabAudio(float[] audioData, int audioDataFloatCount, int channelCount)

Parameters

Type	Name	Description
System.Single[]	audioData
System.Int32	audioDataFloatCount
System.Int32	channelCount

Returns

Type	Description
System.Int32

HasAudio()

Returns true if the media has a audio track

Declaration

public abstract bool HasAudio()

Returns

Type	Description
System.Boolean

HasMetaData()

Declaration

public abstract bool HasMetaData()

Returns

Type	Description
System.Boolean

HasVideo()

Returns true if the media has a visual track

Declaration

public abstract bool HasVideo()

Returns

Type	Description
System.Boolean

IsBuffering()

Declaration

public abstract bool IsBuffering()

Returns

Type	Description
System.Boolean

IsExpectingNewVideoFrame()

Declaration

protected bool IsExpectingNewVideoFrame()

Returns

Type	Description
System.Boolean

IsExternalPlaybackActive()

Check to see if external playback is currently active on the player.

Declaration

public virtual bool IsExternalPlaybackActive()

Returns

Type	Description
System.Boolean

IsExternalPlaybackSupported()

Checks if the media is compatible with external playback, for instance via AirPlay.

Declaration

public virtual bool IsExternalPlaybackSupported()

Returns

Type	Description
System.Boolean

IsFinished()

Declaration

public abstract bool IsFinished()

Returns

Type	Description
System.Boolean

IsLooping()

Declaration

public abstract bool IsLooping()

Returns

Type	Description
System.Boolean

IsMediaCachingSupported()

Test to see if the player can cache media.

Declaration

public virtual bool IsMediaCachingSupported()

Returns

Type	Description
System.Boolean	True if media caching is supported.

IsMuted()

Declaration

public abstract bool IsMuted()

Returns

Type	Description
System.Boolean

IsPaused()

Declaration

public abstract bool IsPaused()

Returns

Type	Description
System.Boolean

IsPlaybackStalled()

Checks if the playback is in a stalled state

Declaration

public virtual bool IsPlaybackStalled()

Returns

Type	Description
System.Boolean

IsPlaying()

Declaration

public abstract bool IsPlaying()

Returns

Type	Description
System.Boolean

IsSeeking()

Declaration

public abstract bool IsSeeking()

Returns

Type	Description
System.Boolean

IsVideoStereo()

Declaration

public bool IsVideoStereo()

Returns

Type	Description
System.Boolean

LoadSubtitlesSRT(String)

Declaration

public bool LoadSubtitlesSRT(string data)

Parameters

Type	Name	Description
System.String	data

Returns

Type	Description
System.Boolean

MuteAudio(Boolean)

Declaration

public abstract void MuteAudio(bool bMuted)

Parameters

Type	Name	Description
System.Boolean	bMuted

OnEnable()

Declaration

public virtual void OnEnable()

OpenMedia(String, Int64, String, MediaHints, Int32, Boolean)

Be careful using this method directly. It is best to instead use the OpenMedia() method in the MediaPlayer component as this will set up the events correctly and also perform other checks customHttpHeaders is in the format "key1:value1\r\nkey2:value2\r\n"=

Declaration

public abstract bool OpenMedia(string path, long offset, string customHttpHeaders, MediaHints mediaHints, int forceFileFormat = 0, bool startWithHighestBitrate = false)

Parameters

Type	Name	Description
System.String	path
System.Int64	offset
System.String	customHttpHeaders
MediaHints	mediaHints
System.Int32	forceFileFormat
System.Boolean	startWithHighestBitrate

Returns

Type	Description
System.Boolean

OpenMediaFromBuffer(Byte[])

Declaration

public virtual bool OpenMediaFromBuffer(byte[] buffer)

Parameters

Type	Name	Description
System.Byte[]	buffer

Returns

Type	Description
System.Boolean

Pause()

Declaration

public abstract void Pause()

PauseDownloadOfMediaToCache(String)

Pause the download of the media specified by url.

Declaration

public virtual void PauseDownloadOfMediaToCache(string url)

Parameters

Type	Name	Description
System.String	url	The url of the media.

Play()

Declaration

public abstract void Play()

PlayerSupportsLinearColorSpace()

Whether this MediaPlayer instance supports linear color space If it doesn't then a correction may have to be made in the shader

Declaration

public virtual bool PlayerSupportsLinearColorSpace()

Returns

Type	Description
System.Boolean

RemoveMediaFromCache(String)

Remove the cached media specified by url.

Declaration

public virtual void RemoveMediaFromCache(string url)

Parameters

Type	Name	Description
System.String	url	The url of the media.

Render()

Declaration

public abstract void Render()

RequiresVerticalFlip()

Returns true if the image on the texture is upside-down

Declaration

public abstract bool RequiresVerticalFlip()

Returns

Type	Description
System.Boolean

ResetAudioFocus()

Declaration

public virtual void ResetAudioFocus()

ResetAudioHeadRotation()

Declaration

public virtual void ResetAudioHeadRotation()

ResumeDownloadOfMediaToCache(String)

Resume the download of the media specified by url.

Declaration

public virtual void ResumeDownloadOfMediaToCache(string url)

Parameters

Type	Name	Description
System.String	url	The url of the media.

Rewind()

Declaration

public virtual void Rewind()

Seek(Double)

The time in seconds seeked will be to the exact time This can take a long time is the keyframes are far apart Some platforms don't support this and instead seek to the closest keyframe

Declaration

public abstract void Seek(double time)

Parameters

Type	Name	Description
System.Double	time

SeekFast(Double)

The time in seconds seeked will be to the closest keyframe

Declaration

public abstract void SeekFast(double time)

Parameters

Type	Name	Description
System.Double	time

SeekToFrame(Int32, Single)

Seek to a specific frame, range is [0, GetMaxFrameNumber()] NOTE: For best results the video should be encoded as keyframes only and have no audio track, or an audio track with the same length as the video track

Declaration

public void SeekToFrame(int frame, float overrideFrameRate = 0F)

Parameters

Type	Name	Description
System.Int32	frame
System.Single	overrideFrameRate

SeekToFrameRelative(Int32, Single)

Seek forwards or backwards relative to the current frame NOTE: For best results the video should be encoded as keyframes only and have no audio track, or an audio track with the same length as the video track

Declaration

public void SeekToFrameRelative(int frameOffset, float overrideFrameRate = 0F)

Parameters

Type	Name	Description
System.Int32	frameOffset
System.Single	overrideFrameRate

SeekWithTolerance(Double, Double, Double)

The time in seconds seeked to will be within the range [time-timeDeltaBefore, time+timeDeltaAfter] for efficiency. Only supported on macOS, iOS and tvOS. Other platforms will automatically pass through to Seek()

Declaration

public virtual void SeekWithTolerance(double time, double timeDeltaBefore, double timeDeltaAfter)

Parameters

Type	Name	Description
System.Double	time
System.Double	timeDeltaBefore
System.Double	timeDeltaAfter

SelectVariant(Variant)

Declaration

public virtual void SelectVariant(Variant variant)

Parameters

Type	Name	Description
Variant	variant

SetActiveAudioTrack(AudioTrack)

Declaration

public void SetActiveAudioTrack(AudioTrack track)

Parameters

Type	Name	Description
AudioTrack	track

SetActiveTextTrack(TextTrack)

Declaration

public void SetActiveTextTrack(TextTrack track)

Parameters

Type	Name	Description
TextTrack	track

SetActiveVideoTrack(VideoTrack)

Declaration

public void SetActiveVideoTrack(VideoTrack track)

Parameters

Type	Name	Description
VideoTrack	track

SetAllowsExternalPlayback(Boolean)

Set whether the player is allowed to switch to external playback, e.g. AirPlay.

Declaration

public virtual void SetAllowsExternalPlayback(bool enable)

Parameters

Type	Name	Description
System.Boolean	enable

SetAudioChannelMode(Audio360ChannelMode)

Declaration

public virtual void SetAudioChannelMode(Audio360ChannelMode channelMode)

Parameters

Type	Name	Description
Audio360ChannelMode	channelMode

SetAudioFocusEnabled(Boolean)

Declaration

public virtual void SetAudioFocusEnabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

SetAudioFocusProperties(Single, Single)

Declaration

public virtual void SetAudioFocusProperties(float offFocusLevel, float widthDegrees)

Parameters

Type	Name	Description
System.Single	offFocusLevel
System.Single	widthDegrees

SetAudioFocusRotation(Quaternion)

Declaration

public virtual void SetAudioFocusRotation(Quaternion q)

Parameters

Type	Name	Description
Quaternion	q

SetAudioHeadRotation(Quaternion)

Declaration

public virtual void SetAudioHeadRotation(Quaternion q)

Parameters

Type	Name	Description
Quaternion	q

SetBalance(Single)

Declaration

public virtual void SetBalance(float balance)

Parameters

Type	Name	Description
System.Single	balance

SetExternalPlaybackVideoGravity(ExternalPlaybackVideoGravity)

Sets the video gravity of the player for external playback only.

Declaration

public virtual void SetExternalPlaybackVideoGravity(ExternalPlaybackVideoGravity gravity)

Parameters

Type	Name	Description
ExternalPlaybackVideoGravity	gravity

SetKeyServerAuthToken(String)

Declaration

public virtual void SetKeyServerAuthToken(string token)

Parameters

Type	Name	Description
System.String	token

SetLooping(Boolean)

Declaration

public abstract void SetLooping(bool looping)

Parameters

Type	Name	Description
System.Boolean	looping

SetOverrideDecryptionKey(Byte[])

Declaration

public virtual void SetOverrideDecryptionKey(byte[] key)

Parameters

Type	Name	Description
System.Byte[]	key

SetPlaybackRate(Single)

Declaration

public abstract void SetPlaybackRate(float rate)

Parameters

Type	Name	Description
System.Single	rate

SetPlayWithoutBuffering(Boolean)

Declaration

public virtual void SetPlayWithoutBuffering(bool playWithoutBuffering)

Parameters

Type	Name	Description
System.Boolean	playWithoutBuffering

SetTextureProperties(FilterMode, TextureWrapMode, Int32)

Declaration

public void SetTextureProperties(FilterMode filterMode = null, TextureWrapMode wrapMode = null, int anisoLevel = 0)

Parameters

Type	Name	Description
FilterMode	filterMode
TextureWrapMode	wrapMode
System.Int32	anisoLevel

SetVolume(Single)

Declaration

public abstract void SetVolume(float volume)

Parameters

Type	Name	Description
System.Single	volume

StartOpenMediaFromBuffer(UInt64)

Declaration

public virtual bool StartOpenMediaFromBuffer(ulong length)

Parameters

Type	Name	Description
System.UInt64	length

Returns

Type	Description
System.Boolean

Stop()

Declaration

public abstract void Stop()

SupportsTextureFrameCount()

Returns whether this platform supports counting the number of times the texture has been updated

Declaration

public virtual bool SupportsTextureFrameCount()

Returns

Type	Description
System.Boolean

Update()

Declaration

public abstract void Update()

UpdateDisplayFrameRate()

Declaration

protected void UpdateDisplayFrameRate()

UpdateSubtitles()

Declaration

public virtual void UpdateSubtitles()

UpdateTextCue(Boolean)

Declaration

protected bool UpdateTextCue(bool force = false)

Parameters

Type	Name	Description
System.Boolean	force

Returns

Type	Description
System.Boolean

UpdateTracks()

Declaration

protected void UpdateTracks()

UpdateVariants()

Declaration

protected virtual void UpdateVariants()

WaitForNextFrame(Camera, Int32)

Declaration

public virtual bool WaitForNextFrame(Camera dummyCamera, int previousFrameCount)

Parameters

Type	Name	Description
Camera	dummyCamera
System.Int32	previousFrameCount

Returns

Type	Description
System.Boolean

Implements

IMediaPlayer

IMediaControl

IMediaInfo

IMediaCache

ITextureProducer

IMediaSubtitles

IVideoTracks

IAudioTracks

ITextTracks

IVariants

System.Collections.Generic.IEnumerable

System.IDisposable