Class MediaPlayer

This is the primary AVPro Video component and handles all media loading, seeking, information retrieving etc. This component does not do any display of the video. Instead this is handled by other components such as ApplyToMesh, ApplyToMaterial, DisplayIMGUI, DisplayUGUI.

Inheritance

System.Object

MediaPlayer

PlaylistMediaPlayer

Implements

MonoBehaviour

ISerializationCallbackReceiver

Namespace: RenderHeads.Media.AVProVideo

Assembly: cs.temp.dll.dll

Syntax

public class MediaPlayer : MonoBehaviour

Fields

_baseMediaPlayer

Declaration

protected BaseMediaPlayer _baseMediaPlayer

Field Value

Type	Description
BaseMediaPlayer

Properties

AudioBalance

Declaration

public float AudioBalance { get; set; }

Property Value

Type	Description
System.Single

AudioFocusEnabled

Declaration

public bool AudioFocusEnabled { get; set; }

Property Value

Type	Description
System.Boolean

AudioFocusOffLevelDB

Declaration

public float AudioFocusOffLevelDB { get; set; }

Property Value

Type	Description
System.Single

AudioFocusTransform

Declaration

public Transform AudioFocusTransform { get; set; }

Property Value

Type	Description
Transform

AudioFocusWidthDegrees

Declaration

public float AudioFocusWidthDegrees { get; set; }

Property Value

Type	Description
System.Single

AudioHeadTransform

Declaration

public Transform AudioHeadTransform { get; set; }

Property Value

Type	Description
Transform

AudioMuted

Declaration

public virtual bool AudioMuted { get; set; }

Property Value

Type	Description
System.Boolean

AudioSource

Declaration

public AudioSource AudioSource { get; }

Property Value

Type	Description
AudioSource

AudioTracks

Declaration

public virtual IAudioTracks AudioTracks { get; }

Property Value

Type	Description
IAudioTracks

AudioVolume

Declaration

public virtual float AudioVolume { get; set; }

Property Value

Type	Description
System.Single

AutoOpen

Declaration

public bool AutoOpen { get; set; }

Property Value

Type	Description
System.Boolean

AutoStart

Declaration

public bool AutoStart { get; set; }

Property Value

Type	Description
System.Boolean

Cache

Declaration

public virtual IMediaCache Cache { get; }

Property Value

Type	Description
IMediaCache

Control

Declaration

public virtual IMediaControl Control { get; }

Property Value

Type	Description
IMediaControl

EventMask

Declaration

public int EventMask { get; set; }

Property Value

Type	Description
System.Int32

Events

Declaration

public MediaPlayerEvent Events { get; }

Property Value

Type	Description
MediaPlayerEvent

FallbackMediaHints

Declaration

public MediaHints FallbackMediaHints { get; set; }

Property Value

Type	Description
MediaHints

ForceFileFormat

Declaration

public FileFormat ForceFileFormat { get; set; }

Property Value

Type	Description
FileFormat

FrameResampler

Declaration

public Resampler FrameResampler { get; }

Property Value

Type	Description
Resampler

HttpHeaders

Declaration

public HttpHeaderData HttpHeaders { get; set; }

Property Value

Type	Description
HttpHeaderData

Info

Declaration

public virtual IMediaInfo Info { get; }

Property Value

Type	Description
IMediaInfo

KeyAuth

Declaration

public KeyAuthData KeyAuth { get; set; }

Property Value

Type	Description
KeyAuthData

Loop

Declaration

public bool Loop { get; set; }

Property Value

Type	Description
System.Boolean

MediaOpened

Declaration

public bool MediaOpened { get; }

Property Value

Type	Description
System.Boolean

MediaPath

Declaration

public MediaPath MediaPath { get; }

Property Value

Type	Description
MediaPath

MediaReference

Declaration

public MediaReference MediaReference { get; }

Property Value

Type	Description
MediaReference

MediaSource

Declaration

public MediaSource MediaSource { get; }

Property Value

Type	Description
MediaSource

PauseMediaOnAppPause

Declaration

public bool PauseMediaOnAppPause { get; set; }

Property Value

Type	Description
System.Boolean

Persistent

Declaration

public bool Persistent { get; set; }

Property Value

Type	Description
System.Boolean

PlatformOptions_iOS

Declaration

public MediaPlayer.OptionsApple PlatformOptions_iOS { get; }

Property Value

Type	Description
MediaPlayer.OptionsApple

PlatformOptions_macOS

Declaration

public MediaPlayer.OptionsApple PlatformOptions_macOS { get; }

Property Value

Type	Description
MediaPlayer.OptionsApple

PlatformOptions_tvOS

Declaration

public MediaPlayer.OptionsApple PlatformOptions_tvOS { get; }

Property Value

Type	Description
MediaPlayer.OptionsApple

PlatformOptions_visionOS

Declaration

public MediaPlayer.OptionsApple PlatformOptions_visionOS { get; }

Property Value

Type	Description
MediaPlayer.OptionsApple

PlatformOptionsAndroid

Declaration

public MediaPlayer.OptionsAndroid PlatformOptionsAndroid { get; }

Property Value

Type	Description
MediaPlayer.OptionsAndroid

PlatformOptionsOpenHarmony

Declaration

public MediaPlayer.OptionsOpenHarmony PlatformOptionsOpenHarmony { get; }

Property Value

Type	Description
MediaPlayer.OptionsOpenHarmony

PlatformOptionsWebGL

Declaration

public MediaPlayer.OptionsWebGL PlatformOptionsWebGL { get; }

Property Value

Type	Description
MediaPlayer.OptionsWebGL

PlatformOptionsWindows

Declaration

public MediaPlayer.OptionsWindows PlatformOptionsWindows { get; }

Property Value

Type	Description
MediaPlayer.OptionsWindows

PlatformOptionsWindowsUWP

Declaration

public MediaPlayer.OptionsWindowsUWP PlatformOptionsWindowsUWP { get; }

Property Value

Type	Description
MediaPlayer.OptionsWindowsUWP

PlaybackRate

Declaration

public float PlaybackRate { get; set; }

Property Value

Type	Description
System.Single

Player

Declaration

public virtual IMediaPlayer Player { get; }

Property Value

Type	Description
IMediaPlayer

PlayMediaOnAppUnpause

Declaration

public bool PlayMediaOnAppUnpause { get; set; }

Property Value

Type	Description
System.Boolean

ResampleBufferSize

Declaration

public int ResampleBufferSize { get; set; }

Property Value

Type	Description
System.Int32

ResampleMode

Declaration

public Resampler.ResampleMode ResampleMode { get; set; }

Property Value

Type	Description
Resampler.ResampleMode

SideloadSubtitles

Declaration

public bool SideloadSubtitles { get; set; }

Property Value

Type	Description
System.Boolean

SubtitlePath

Declaration

public MediaPath SubtitlePath { get; set; }

Property Value

Type	Description
MediaPath

Subtitles

Declaration

public virtual IMediaSubtitles Subtitles { get; }

Property Value

Type	Description
IMediaSubtitles

TextTracks

Declaration

public virtual ITextTracks TextTracks { get; }

Property Value

Type	Description
ITextTracks

TextureAnisoLevel

Declaration

public int TextureAnisoLevel { get; set; }

Property Value

Type	Description
System.Int32

TextureFilterMode

Declaration

public FilterMode TextureFilterMode { get; set; }

Property Value

Type	Description
FilterMode

TextureProducer

Declaration

public virtual ITextureProducer TextureProducer { get; }

Property Value

Type	Description
ITextureProducer

TextureWrapMode

Declaration

public TextureWrapMode TextureWrapMode { get; set; }

Property Value

Type	Description
TextureWrapMode

UseResampler

Declaration

public bool UseResampler { get; set; }

Property Value

Type	Description
System.Boolean

Variants

Declaration

public virtual IVariants Variants { get; }

Property Value

Type	Description
IVariants

VideoLayoutMapping

Declaration

public VideoMapping VideoLayoutMapping { get; set; }

Property Value

Type	Description
VideoMapping

VideoTracks

Declaration

public virtual IVideoTracks VideoTracks { get; }

Property Value

Type	Description
IVideoTracks

Methods

AddChunkToVideoBuffer(Byte[], UInt64, UInt64)

Declaration

public bool AddChunkToVideoBuffer(byte[] chunk, ulong offset, ulong chunkSize)

Parameters

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

Returns

Type	Description
System.Boolean

CloseMedia()

Declaration

public void CloseMedia()

CreateMediaPlayer()

Declaration

public virtual BaseMediaPlayer CreateMediaPlayer()

Returns

Type	Description
BaseMediaPlayer

DisableSubtitles()

Declaration

public void DisableSubtitles()

EnableSubtitles(MediaPath)

Declaration

public bool EnableSubtitles(MediaPath mediaPath)

Parameters

Type	Name	Description
MediaPath	mediaPath

Returns

Type	Description
System.Boolean

EndOpenChunkedVideoFromBuffer()

Declaration

public bool EndOpenChunkedVideoFromBuffer()

Returns

Type	Description
System.Boolean

ExtractFrame(Texture2D, Double, Boolean, Int32, Int32)

Declaration

public Texture2D ExtractFrame(Texture2D target, double timeSeconds = -1, bool accurateSeek = true, int timeoutMs = 1000, int timeThresholdMs = 100)

Parameters

Type	Name	Description
Texture2D	target
System.Double	timeSeconds
System.Boolean	accurateSeek
System.Int32	timeoutMs
System.Int32	timeThresholdMs

Returns

Type	Description
Texture2D

ExtractFrameAsync(Texture2D, MediaPlayer.ProcessExtractedFrame, Double, Boolean, Int32, Int32)

Declaration

public void ExtractFrameAsync(Texture2D target, MediaPlayer.ProcessExtractedFrame callback, double timeSeconds = -1, bool accurateSeek = true, int timeoutMs = 1000, int timeThresholdMs = 100)

Parameters

Type	Name	Description
Texture2D	target
MediaPlayer.ProcessExtractedFrame	callback
System.Double	timeSeconds
System.Boolean	accurateSeek
System.Int32	timeoutMs
System.Int32	timeThresholdMs

ForceDispose()

Declaration

public void ForceDispose()

GetCurrentPlatformOptions()

Declaration

public MediaPlayer.PlatformOptions GetCurrentPlatformOptions()

Returns

Type	Description
MediaPlayer.PlatformOptions

GetPlatform()

Declaration

public static Platform GetPlatform()

Returns

Type	Description
Platform

Initialise()

Declaration

protected void Initialise()

IsHandleEvent(MediaPlayerEvent.EventType)

Declaration

protected bool IsHandleEvent(MediaPlayerEvent.EventType eventType)

Parameters

Type	Name	Description
MediaPlayerEvent.EventType	eventType

Returns

Type	Description
System.Boolean

IsUsingAndroidOESPath()

Declaration

public bool IsUsingAndroidOESPath()

Returns

Type	Description
System.Boolean

IsUsingYCbCr()

Declaration

public bool IsUsingYCbCr()

Returns

Type	Description
System.Boolean

OnDestroy()

Declaration

protected virtual void OnDestroy()

OpenMedia(MediaPath, Boolean)

Declaration

public bool OpenMedia(MediaPath path, bool autoPlay = true)

Parameters

Type	Name	Description
MediaPath	path
System.Boolean	autoPlay

Returns

Type	Description
System.Boolean

OpenMedia(MediaPathType, String, Boolean)

Declaration

public bool OpenMedia(MediaPathType pathType, string path, bool autoPlay = true)

Parameters

Type	Name	Description
MediaPathType	pathType
System.String	path
System.Boolean	autoPlay

Returns

Type	Description
System.Boolean

OpenMedia(MediaReference, Boolean)

Declaration

public bool OpenMedia(MediaReference mediaReference, bool autoPlay = true)

Parameters

Type	Name	Description
MediaReference	mediaReference
System.Boolean	autoPlay

Returns

Type	Description
System.Boolean

OpenMedia(Boolean)

Declaration

public bool OpenMedia(bool autoPlay = true)

Parameters

Type	Name	Description
System.Boolean	autoPlay

Returns

Type	Description
System.Boolean

OpenMediaFromBuffer(Byte[], Boolean)

Declaration

public bool OpenMediaFromBuffer(byte[] buffer, bool autoPlay = true)

Parameters

Type	Name	Description
System.Byte[]	buffer
System.Boolean	autoPlay

Returns

Type	Description
System.Boolean

Pause()

Declaration

public virtual void Pause()

Play()

Declaration

public virtual void Play()

Rewind(Boolean)

Declaration

public void Rewind(bool pause)

Parameters

Type	Name	Description
System.Boolean	pause

SeekToLiveTime(Double)

Declaration

public void SeekToLiveTime(double offset = 0)

Parameters

Type	Name	Description
System.Double	offset

SetAudioSource(AudioSource)

Declaration

public void SetAudioSource(AudioSource audioSource)

Parameters

Type	Name	Description
AudioSource	audioSource

SetMediaPath(MediaPath)

Declaration

public void SetMediaPath(MediaPath path)

Parameters

Type	Name	Description
MediaPath	path

SetMediaReference(MediaReference)

Declaration

public void SetMediaReference(MediaReference media)

Parameters

Type	Name	Description
MediaReference	media

SetMediaSource(MediaSource)

Declaration

public void SetMediaSource(MediaSource source)

Parameters

Type	Name	Description
MediaSource	source

StartOpenChunkedMediaFromBuffer(UInt64, Boolean)

Declaration

public bool StartOpenChunkedMediaFromBuffer(ulong length, bool autoPlay = true)

Parameters

Type	Name	Description
System.UInt64	length
System.Boolean	autoPlay

Returns

Type	Description
System.Boolean

StartRenderCoroutine()

Declaration

protected void StartRenderCoroutine()

Stop()

Declaration

public void Stop()

Update()

Declaration

protected virtual void Update()

Implements

MonoBehaviour

ISerializationCallbackReceiver