Ringback tone's main entry point. More...

#include <RingBackToneControl.h>

Inheritance diagram for ZDK_NET::RingBackToneControl:

Public Member Functions
	RingBackToneControl (ZDK::Shared::RingBackToneControl src)

ZDK_NET::Result ^	Play ()
	Starts the ringback tone playing. More...

ZDK_NET::Result ^	Stop ()
	Stops the playing of the ringback tone. More...

virtual long long	Handle () override

virtual void	Initialize () override

virtual void	ReleaseReference () override

Public Attributes
ZDK::IRingBackToneControl *	cppRef = nullptr

Properties
bool	Enable `[get, set]`
	Gets the configured use of ringback tone. More...

ZDK_NET::Sound^	RingBackSound `[get, set]`
	Sets the configured ringback sound. More...

Detailed Description

Ringback tone's main entry point.

Entry point for controlling the ringback tone heard by the user when the remote peer starts ringing

Member Function Documentation

◆ Play()

ZDK_NET::Result ^ ZDK_NET::RingBackToneControl::Play ( )

Starts the ringback tone playing.

The ringback tone will be played only if it is not already running and enabled! Error will be returned otherwise.

Returns: Result of the invocation

See also: Result, Enable()

◆ Stop()

ZDK_NET::Result ^ ZDK_NET::RingBackToneControl::Stop ( )

Stops the playing of the ringback tone.

The ringback tone will be stoped only if it is already running and enabled! Error will be returned otherwise.

Returns: Result of the invocation

See also: Result

Property Documentation

◆ Enable

bool ZDK_NET::RingBackToneControl::Enable

getset

Gets the configured use of ringback tone.

Whether ringback tones can be played or not.

ENABLED by default!

Parameters

[in]

value

0 - disabled
1 - enabled

◆ RingBackSound

ZDK_NET:: Sound^ ZDK_NET::RingBackToneControl::RingBackSound

getset

Sets the configured ringback sound.

Parameters

[in] value The new ringback sound to be used

See also: Sound

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

Controllers/RingBackToneControl.h

Public Member Functions

Public Attributes