Detailed Description

Asset representing a video.

Contains an URL to a video. This URL can be either local (using a file:// URL), or remote.

See also: CYIAbstractVideoPlayer

#include <asset/YiAssetVideo.h>

Inheritance diagram for CYIAssetVideo:

Public Member Functions
	CYIAssetVideo ()

	CYIAssetVideo (const CYIString &path, PATH_TYPE ePathType=PATH_RELATIVE)

virtual	~CYIAssetVideo ()

void	SetUrl (const CYIString &path)

void	SetUrl (const CYIUrl &url)

const CYIUrl &	GetUrl () const

Public Member Functions inherited from CYIAsset
virtual	~CYIAsset ()

const CYIString &	GetPath () const

CYIAssetLoadParams *	GetLoadParameters () const

bool	SetName (const CYIString &name)

const CYIString &	GetName () const

bool	Load ()

void	Unload ()

bool	IsLoaded () const

bool	Equals (const std::shared_ptr< CYIAsset > &pAsset)

virtual bool	Prepare ()

Public Member Functions inherited from CYIScriptableRTTIObject
	CYIScriptableRTTIObject ()

virtual	~CYIScriptableRTTIObject ()

virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const override

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)

Protected Member Functions
virtual std::pair< uint32_t, uint32_t >	GetApproximateSize () const override

Protected Member Functions inherited from CYIAsset
	CYIAsset ()

ssize_t	GetID () const

void	SetPath (const CYIString &path, PATH_TYPE ePathType)

void	SetApproximateSize (uint32_t nSize)

void	SetLoaded (bool bAssetLoaded)

void	SetLoadParameters (std::unique_ptr< CYIAssetLoadParams > pParams)

virtual void	OnLoad ()

virtual void	OnUnload ()

Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo , const void >	GetRuntimeTypeInfoWithObject () const =0

Additional Inherited Members
Public Types inherited from CYIAsset
enum	PATH_TYPE { PATH_ABSOLUTE = 0, PATH_RELATIVE }

Static Protected Attributes inherited from CYIAsset
static ssize_t	INVALID_ID

Constructor & Destructor Documentation

CYIAssetVideo::CYIAssetVideo ( )

CYIAssetVideo::CYIAssetVideo	(	const CYIString &	path,
		PATH_TYPE	ePathType = `PATH_RELATIVE`
	)

virtual CYIAssetVideo::~CYIAssetVideo ( )

virtual

Member Function Documentation

virtual std::pair<uint32_t, uint32_t> CYIAssetVideo::GetApproximateSize ( ) const

overrideprotectedvirtual

Calculates and returns the approximate number of bytes currently used by this asset. The first item of the returned pair object represents the memory currently taken in the CPU main memory, and the second item of the returned pair object represents the memory currently taken in the GPU memory.

Note: This function only returns an approximate memory consumption as the exact memory consumption changes depending on the used C++ libraries and on the specific GPU infrastructure and drivers used by the system.

Reimplemented from CYIAsset.

const CYIUrl& CYIAssetVideo::GetUrl ( ) const

Returns the URL associated with this video asset.

void CYIAssetVideo::SetUrl ( const CYIString & path )

Sets the URL for this video to one created from the path path. The path must be absolute. The assigned URL will use the file:// scheme.

void CYIAssetVideo::SetUrl ( const CYIUrl & url )

Sets the URL for this video to url.

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

asset/YiAssetVideo.h

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation