You.i Engine
CYIVideoSurfacePlatform Class Referenceabstract

Detailed Description

Representation of a CYIAbstractVideoPlayer's video surface, if the player is rendering to a platform-level view outside of You.i Engine.

CYIVideoSurfacePlatform classes are implicitly not CYIVideoSurface::Capabilities::RenderToTexture, even if subclasses claim they are

#include <player/YiVideoSurfacePlatform.h>

Inheritance diagram for CYIVideoSurfacePlatform:

Protected Member Functions

 CYIVideoSurfacePlatform (Capabilities capabilities)
 
virtual void SetVideoRectangle (const YI_RECT_REL &videoRectangle)=0
 
virtual void OnAttached (CYIVideoSurfaceView *pVideoSurfaceView) override
 
virtual void OnDetached (CYIVideoSurfaceView *pVideoSurfaceView) override
 
- Protected Member Functions inherited from CYIVideoSurface
 CYIVideoSurface (Capabilities capabilities)
 

Friends

class CYIVideoSurfaceView
 

Additional Inherited Members

- Public Types inherited from CYIVideoSurface
enum  Capabilities {
  Capabilities::None = 0x00,
  Capabilities::RenderToTexture = 0x01,
  Capabilities::MultipleViews = 0x02,
  Capabilities::Translate = 0x04,
  Capabilities::Scale = 0x08,
  Capabilities::FreeTransform = 0x10,
  Capabilities::Opacity = 0x20
}
 
- Public Member Functions inherited from CYIVideoSurface
virtual ~CYIVideoSurface ()
 
virtual void Init ()
 
Capabilities GetCapabilities () const
 
void SetClosedCaptionsDispatcher (CYIClosedCaptionsDispatcher *pDispatcher)
 
CYIClosedCaptionsDispatcherGetClosedCaptionsDispatcher () const
 
const glm::ivec2 & GetSize () const
 
void SetSize (const glm::ivec2 &videoSize)
 
- Public Attributes inherited from CYIVideoSurface
CYISignal< const glm::ivec2 & > SizeChanged
 

Constructor & Destructor Documentation

◆ CYIVideoSurfacePlatform()

CYIVideoSurfacePlatform::CYIVideoSurfacePlatform ( Capabilities  capabilities)
protected

Member Function Documentation

◆ OnAttached()

virtual void CYIVideoSurfacePlatform::OnAttached ( CYIVideoSurfaceView pVideoSurfaceView)
overrideprotectedvirtual

Called when the CYIVideoSurface has been attached to a CYIVideoSurfaceView.

Note
Subclasses must call the parent OnAttached function.

Reimplemented from CYIVideoSurface.

◆ OnDetached()

virtual void CYIVideoSurfacePlatform::OnDetached ( CYIVideoSurfaceView pVideoSurfaceView)
overrideprotectedvirtual

Called when the CYIVideoSurface has been detached from a CYIVideoSurfaceView.

Note
Subclasses must call the parent OnDetached function.

Reimplemented from CYIVideoSurface.

◆ SetVideoRectangle()

virtual void CYIVideoSurfacePlatform::SetVideoRectangle ( const YI_RECT_REL videoRectangle)
protectedpure virtual

Positions the platform view such that the video frame appears in the videoRectangle, defined in the coordinate system of the You.i Engine view, which is usually screen-space.

Note
On Tizen when using the player provided by CYIDefaultVideoPlayerFactory the CYIAbstractVideoPlayer must be in the MediaState::Unloaded state before calling this method. Calling this method when the player is not in the MediaState::Unloaded state will have no effect.
See also
Capabilities

Friends And Related Function Documentation

◆ CYIVideoSurfaceView

friend class CYIVideoSurfaceView
friend

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