目录

SinkNode

Struct Info

struct SinkNode

Sink节点类，继承NodeBase，处于Pipeline尾部且对数据进行Sink的节点，有与之相连的上游节点，但不存在下游节点。

父类NodeBase中的接口在此处不再赘述。

Public Constructor Summary

Constructor Name

SinkNode(const char *mime, bool isProcThreadCreated, bool isAsync)

构造函数。

Public Function Summary

Qualifier and Type

Function Name and Description

int64_t

GetCurrentPosition() const

获取当前的播放位置。

RetCode

SetVolume(double)

设置播放音量。

double

GetVolume() const

获取当前播放的音量。

RetCode

SetMute(bool)

设置是否静音。

bool

GetMute() const

查询当前是否静音。

RetCode

SetAudioStreamType(int)

设置音频流类型。

ClockCoreSP

ProvideClock()

获取同步时钟。

RetCode

SetClock(ClockCoreSP)

设置同步时钟。

Public Constructors

[h2]SinkNode

Constructor

SinkNode(const char *mime, bool isProcThreadCreated, bool isAsync)

构造函数。

Parameters

Name

Description

mime

指定节点的mime类型。

isProcThreadCreated

是否需要创建处理buffer的线程，当SinkNode没有比较耗时的操作时，设置为false。

  • true：需要创建，默认。
  • false：不需要创建。

isAsync

指定节点工作在同步还是异步状态。

  • true：异步状态。
  • false：同步状态。

Public Functions

[h2]GetCurrentPosition

Function

virtual int64_t GetCurrentPosition() const

查询当前的播放进度，用时间戳表示。

Returns

Type

Description

int64_t

时间戳。

[h2]SetVolume

Function

virtual RetCode SetVolume(double)

设置音量。

Parameters

Name

Description

double

待设置的音量，取值范围[0, 1]。

Returns

Type

Description

RetCode

错误码。

[h2]GetVolume

Function

virtual double GetVolume() const

获取当前的播放音量。

Returns

Type

Description

double

音量。

[h2]SetMute

Function

virtual RetCode SetMute(bool)

设置是否静音。

Parameters

Name

Description

bool
  • true：设置静音。
  • false：设置有声。

Returns

Type

Description

RetCode

错误码。

[h2]GetMute

Function

virtual bool GetMute() const

获取当前是否静音。

Returns

Type

Description

bool
  • true：已静音。
  • false：未静音。

[h2]SetAudioStreamType

Function

virtual RetCode SetAudioStreamType(int type)

设置音频流类型。

Parameters

Name

Description

type

待设置的音频流类型。详见StreamType

Returns

Type

Description

RetCode

错误码。

[h2]ProvideClock

Function

ClockCoreSP ProvideClock()

从该节点获取同步时钟。

Returns

Type

Description

ClockCoreSP

返回ClockCore的智能指针。

[h2]SetClock

Function

RetCode SetClock(ClockCoreSP clock)

设置同步时钟给该节点。

Parameters

Name

Description

clock

待设置的同步时钟。

Returns

Type

Description

RetCode

错误码。