ZDK
Public Member Functions | List of all members
ZDK::IRingBackToneControl Class Referenceabstract

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

#include <IRingBackToneControl.h>

Inheritance diagram for ZDK::IRingBackToneControl:
ZDK::IZHandle

Public Member Functions

virtual ZDK::Shared::Result Play ()=0
 Starts the ringback tone playing. More...
 
virtual ZDK::Shared::Result Stop ()=0
 Stops the playing of the ringback tone. More...
 
virtual bool Enable ()=0
 Configures the use of ringback tone. More...
 
virtual void Enable (bool value)=0
 Gets the configured use of ringback tone. More...
 
- Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle Handle () const =0
 
virtual operator ZDK::ZDKHandle () const =0
 
virtual void Initialize ()=0
 
virtual void ReleaseReference ()=0
 

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

◆ Enable() [1/2]

virtual bool ZDK::IRingBackToneControl::Enable ( )
pure virtual

Configures the use of ringback tone.

Whether ringback tones can be played or not.

Returns
  • 0 - disabled
  • 1 - enabled

◆ Enable() [2/2]

virtual void ZDK::IRingBackToneControl::Enable ( bool  value)
pure virtual

Gets the configured use of ringback tone.

Whether ringback tones can be played or not.

Parameters
[in]value
  • 0 - disabled
  • 1 - enabled

◆ Play()

virtual ZDK::Shared::Result ZDK::IRingBackToneControl::Play ( )
pure virtual

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
IResult, Enable()

◆ Stop()

virtual ZDK::Shared::Result ZDK::IRingBackToneControl::Stop ( )
pure virtual

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
IResult

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