继承自 MonoBehaviour .

Public 成员函数

void SetGameFps (uint fps)
 
void SetForUser (uint uid)
 
void SetForMultiChannelUser (string channelId, uint uid)
 
void EnableFilpTextureApply (bool enableFlipHorizontal, bool enableFlipVertical)
 
void SetVideoSurfaceType (AgoraVideoSurfaceType agoraVideoSurfaceType)
 
void SetEnable (bool enable)
 

详细描述

VideoSurface 类的定义。

成员函数说明

◆ SetGameFps()

void VideoSurface.SetGameFps ( uint  fps)

设置视频渲染帧率。

注解
  • 确保在主线程中调用此方法。
  • 确保在绑定 VideoSurface.cs 前调用此方法。
参数
fps实际的程序刷新帧率。

◆ SetForUser()

void VideoSurface.SetForUser ( uint  uid)

设置本地/远端视频显示。

注解
  • 确保在主线程中调用此方法。
  • 不要和 SetForMultiChannelUser 同时使用。
  • 确保在绑定 VideoSurface.cs 前调用此方法。
参数
uid远端用户的 uid,通过 OnUserJoinedHandler 获得的 uid。默认值为 0,表示可以看到本地视频。

◆ SetForMultiChannelUser()

void VideoSurface.SetForMultiChannelUser ( string  channelId,
uint  uid 
)

在多频道中设置本地/远端视频显示。

自从
v3.0.1
注解
  • 该方法仅适用于多频道。
  • 不要和 SetForUser 同时使用。
  • 确保在主线程中调用此方法。
  • 确保在绑定 VideoSurface.cs 前调用此方法。
参数
channelId频道 ID。
uid远端用户的 uid,通过 OnUserJoinedHandler 获得的 uid。默认值为 0,表示可以看到本地视频。

◆ EnableFilpTextureApply()

void VideoSurface.EnableFilpTextureApply ( bool  enableFlipHorizontal,
bool  enableFlipVertical 
)

在渲染时,开启/关闭 Texture 的镜像。

注解
  • 确保在主线程中调用此方法。
  • 确保在绑定 VideoSurface.cs 前调用此方法。
参数
enableFlipHorizontal是否开启 Texture 在水平方向的镜像:
  • true:开启
  • false:(默认)不开启
enableFlipVertical是否开启 Texture 在垂直方向的镜像:
  • true:开启
  • false:(默认)不开启

◆ SetVideoSurfaceType()

void VideoSurface.SetVideoSurfaceType ( AgoraVideoSurfaceType  agoraVideoSurfaceType)

设置视频渲染器。

参数
agoraVideoSurfaceType渲染器类型,详见 AgoraVideoSurfaceType :
  • Renderer(0): 该渲染器通常用于渲染 3D GameObject,例如 Cube、Cylinder 和 Plane。
  • RawImage(1): 该渲染器通常用于渲染 UI 组件下的 Raw Image。

◆ SetEnable()

void VideoSurface.SetEnable ( bool  enable)

开始/停止视频渲染。

参数
enable是否开始视频渲染。
  • true:(默认)开启
  • false:不开启