Table of Contents

Namespace RenderHeads.Media.AVProVideo

Classes

Name Description
Android
ApplyToBase

Base class to apply texture from MediaPlayer

ApplyToFarPlane

displays the video to the far camera plane

ApplyToMaterial

Sets up a material to display the video from a MediaPlayer

ApplyToMesh

Sets up a mesh to display the video from a MediaPlayer

AssetBundleParser
AudioChannelMixer
AudioOutput

Audio is grabbed from the MediaPlayer and rendered via Unity AudioSource This allows audio to have 3D spatial control, effects applied and to be spatialised for VR Currently supported on Windows and UWP (Media Foundation API only), macOS, iOS, tvOS and Android (ExoPlayer API only)

AudioOutputManager

A singleton to handle multiple instances of the AudioOutput component

AudioTrack
AudioTracks
AuthData
BaseMediaPlayer

Base class for all platform specific MediaPlayers

CubemapCube

Builds a cube mesh for displaying a 360 degree "Cubemap 3x2 facebook layout" texture in VR

DisplayBackground

Draws video over the whole background using the special "background" tag on the shader. Useful for augmented reality. NOTE: This doesn't work with the camera clear mode set to 'skybox'

DisplayIMGUI

Displays the video from MediaPlayer component using IMGUI

DisplayUGUI

Displays the video from MediaPlayer component using uGUI

Easing

Easing functions

Helper
Helper.ExpectedPluginVersion
HttpHeaderData

Data for handling custom HTTP header fields

KeyAuthData

Data for handling authentication of encrypted AES-128 HLS streams

MediaCachingOptions

Options for configuring media caching.

MediaPath
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.

MediaPlayer.OptionsAndroid
MediaPlayer.OptionsApple
MediaPlayer.OptionsOpenHarmony
MediaPlayer.OptionsWebGL
MediaPlayer.OptionsWindows
MediaPlayer.OptionsWindowsUWP
MediaPlayer.PlatformOptions
MediaPlayerEvent
MediaPlayerLoadEvent
MediaPlaylist
MediaPlaylist.MediaItem
MediaReference
NullMediaPlayer

This media player fakes video playback for platforms that aren't supported

OptionsAppleExtensions
PlaybackQualityStats

Attempts to give insight into video playback presentation smoothness quality Keeps track of skipped and duplicated frames and warns about suboptimal setup such as no vsync enabled or video frame rate not being a multiple of the display frame rate

PlaylistMediaPlayer

This is a BETA component

PluginWarmup
Resampler

Utility class to resample MediaPlayer video frames to allow for smoother playback Keeps a buffer of frames with timestamps and presents them using its own clock

ResolveToRenderTexture
Subtitle
SubtitlePlayer
SubtitleUtils
SubtitlesUGUI

Update a standard uGUI Text element with subtitle text as it plays from the MediaPlayer

TextCue
TextTrack
TextTracks
TimeRanges
TimedMetadataItem
TrackBase
TrackCollection
TrackCollection<T>
UpdateMultiPassStereo

This script is needed to send the camera position to the stereo shader so that it can determine which eye it is rendering. This is only needed for multi-pass rendering, as single pass has a built-in shader variable

Variant
VideoPlayer_AVPro
VideoRender

Helper class for everything related to setting up materials for rendering/resolving videos

VideoTrack
VideoTracks
WebGL
WebGLMediaPlayer

WebGL implementation of BaseMediaPlayer

Windows
WindowsMediaPlayer

Windows desktop and UWP implementation of BaseMediaPlayer

WindowsRtMediaPlayer
WindowsUWP

Structs

Name Description
HttpHeader
LazyShaderProperty
MediaHints
TextureFrame
TimeRange
VideoResolveOptions

Interfaces

Name Description
IAudioTracks
IMediaCache

Interface for the media cache.

IMediaControl
IMediaInfo
IMediaPlayer
IMediaSubtitles

Interface for side loading of subtitles in SRT format

ITextTracks
ITextureProducer
ITimedMetadata
IVariants
IVideoTracks

Enums

Name Description
AlphaPacking
Android.AudioOutput
Android.TextureFiltering
Android.VideoApi
Android.VideoOutputMode
Audio360ChannelMode
AudioChannelMaskFlags
AudioOutput.AudioOutputMode
CachedMediaStatus

Status of the media item in the cache.

CodecType
CubemapCube.Layout
DisplayType

The different display types that are available within AVPro

Easing.Preset
ErrorCode
ExternalPlaybackVideoGravity

Video gravity to use with external playback.

FileFormat
GetCompatibleRenderTextureFormatOptions

Options for passing into GetCompatibleRenderTextureFormat

MediaPathType
MediaPlayer.OptionsAndroid.ChangeFlags
MediaPlayer.OptionsAndroid.VideoOutputMode
MediaPlayer.OptionsApple.ChangeFlags
MediaPlayer.OptionsApple.Flags
MediaPlayer.OptionsOpenHarmony.ChangeFlags
MediaPlayer.OptionsWebGL.ChangeFlags
MediaPlayer.PlatformOptions.AudioMode
MediaPlayer.PlatformOptions.BitRateUnits
MediaPlayer.PlatformOptions.Resolution
MediaPlayer.PlatformOptions.TextureFormat
MediaPlayerEvent.EventType
MediaPlaylist.MediaItem.SourceType
MediaSource
Orientation
OverrideMode
Platform
PlaybackState
PlaylistMediaPlayer.PlaylistLoopMode
PlaylistMediaPlayer.ProgressMode
PlaylistMediaPlayer.StartMode
PlaylistMediaPlayer.Transition
Resampler.ResampleMode
StereoEye
StereoPacking
TextureFlags
TextureGamma
TrackType
TransparencyMode
VariantFlags
VideoMapping
VideoRange
VideoRender.ResolveFlags
VideoResolveOptions.AspectRatio
WebGL.ExternalLibrary
Windows.AudioOutput
Windows.VideoApi
WindowsUWP.AudioOutput
WindowsUWP.VideoApi

Delegates

Name Description
MediaPlayer.ProcessExtractedFrame
VideoPlayer_AVPro.ErrorEventHandler
VideoPlayer_AVPro.EventHandler
VideoPlayer_AVPro.FrameReadyEventHandler
VideoPlayer_AVPro.TimeEventHandler