CYIVideoSurface Class Reference

Detailed Description

Representation of a CYIAbstractVideoPlayer's video surface.

The CYIVideoSurface represents visual information associated with a CYIAbstractVideoPlayer. It contains information about the video's size and location, and if applicable it also contains the video buffer's data in a texture for display by the user. This class also contains a reference to a CYIClosedCaptionsDispatcher instance if the player requires the CYIVideoSurfaceView to render closed captions.

The CAPABILITIES describe the features supported by the underlying video player and platform. Application developers should query and respect the capabilities of the surface in their code.

In order to display the video in your user interface you must assign the CYIVideoSurface to a CYIVideoSurfaceView. This CYIVideoSurfaceView may have design limitations imposed on it by the CAPABILITIES and these must be taken into consideration during the design of the interface, for more information see CYIVideoSurfaceView.

See also

CYIVideoSurfaceView

CYIAbstractVideoPlayer

#include <player/YiVideoSurface.h>

Inheritance diagram for CYIVideoSurface:

Public Types
enum	CAPABILITIES {   RENDER_TO_TEXTURE = 0x1,   MULTIPLE_VIEWS = 0x2,   TRANSLATE = 0x4,   SCALE = 0x8,   FREE_TRANSFORM = 0x10,   OPACITY = 0x20 }

Public Member Functions
virtual	~CYIVideoSurface ()
virtual void	Init ()
uint32_t	GetCapabilities () const
void	SetClosedCaptionsDispatcher (CYIClosedCaptionsDispatcher *pDispatcher)
CYIClosedCaptionsDispatcher *	GetClosedCaptionsDispatcher () const
const glm::ivec2 &	GetSize () const
Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()
	CYIScriptableObject (const CYIScriptableObject &other)
CYIScriptableObject &	operator= (const CYIScriptableObject &other)
virtual	~CYIScriptableObject ()
CYIBindingImplementation *	GetBindingImplementation () const
void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const

Public Attributes
CYISignal< const glm::ivec2 & >	SizeChanged

Protected Member Functions
	CYIVideoSurface (uint32_t uCapabilities)
void	SetSize (const glm::ivec2 &videoSize)
virtual void	OnAttached (CYIVideoSurfaceView *pVideoSurfaceView)
virtual void	OnDetached (CYIVideoSurfaceView *pVideoSurfaceView)

Friends
class	CYIAbstractVideoPlayer
class	CYIVideoSurfaceView

Member Enumeration Documentation

enum CYIVideoSurface::CAPABILITIES

Enumerator
RENDER_TO_TEXTURE	If this capability is reported the video data will be rendered into the m_pVideoTexture member variable. Otherwise, the actual video data is being rendered outside of You.i Engine.
MULTIPLE_VIEWS	If this capability is reported the surface can be displayed in multiple CYIVideoSurfaceViews.
TRANSLATE	If this capability is reported the video surface is capable of being translated around on the screen.
SCALE	If this capability is reported the video surface may be scaled freely
FREE_TRANSFORM	If this capability is reported the video surface may be freely transformed in 3-dimensions like any other view.
OPACITY	If this capability is reported the video surface can be blended with the rest of the scene

Constructor & Destructor Documentation

virtual CYIVideoSurface::~CYIVideoSurface ( )

virtual

CYIVideoSurface::CYIVideoSurface ( uint32_t  uCapabilities )

protected

Member Function Documentation

uint32_t CYIVideoSurface::GetCapabilities

(

)

const

Returns the capabilities supported by the video surface.

See also

CAPABILITIES

CYIClosedCaptionsDispatcher* CYIVideoSurface::GetClosedCaptionsDispatcher

(

)

const

Returns the closed captions dispatcher object owned by the associated video player.

const glm::ivec2& CYIVideoSurface::GetSize

(

)

const

Returns the size of the video buffer contents. This is the native resolution of the video being rendered, and may vary from the size of the view in which this surface is displayed.

virtual void CYIVideoSurface::Init ( )

virtual

On

See also

CYIVideoSurfaceTexture types, the material and texture will be initialized here.

Reimplemented in CYIVideoSurfaceTexture.

virtual void CYIVideoSurface::OnAttached ( CYIVideoSurfaceView *  pVideoSurfaceView )

protectedvirtual

Called when the CYIVideoSurface has been attached to a CYIVideoSurfaceView.

Note

Subclasses must call the parent OnAttached function.

Reimplemented in CYIVideoSurfacePlatform.

virtual void CYIVideoSurface::OnDetached ( CYIVideoSurfaceView *  pVideoSurfaceView )

protectedvirtual

Called when the CYIVideoSurface has been detached from a CYIVideoSurfaceView.

Note

Subclasses must call the parent OnDetached function.

Reimplemented in CYIVideoSurfacePlatform.

void CYIVideoSurface::SetClosedCaptionsDispatcher

(

CYIClosedCaptionsDispatcher *

pDispatcher

)

Sets the closed captions dispatcher used by this object to pDispatcher. Video players that make use of in-engine closed captions rendering must call this function.

void CYIVideoSurface::SetSize ( const glm::ivec2 &  videoSize )

protected

The size of the video surface should represent the native resolution of the video asset. This can change as new assets are loaded into the player. Set by the CYIAbstractVideoPlayer

Friends And Related Function Documentation

friend class CYIAbstractVideoPlayer

friend

friend class CYIVideoSurfaceView

friend

Member Data Documentation

CYISignal<const glm::ivec2 &> CYIVideoSurface::SizeChanged

Emitted when the size of the surface changes.

---

The documentation for this class was generated from the following file:

• player/YiVideoSurface.h