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

#import <ZDKRingBackToneControl.h>

Inheritance diagram for <ZDKRingBackToneControl>:

Instance Methods
(id< ZDKResult >)	- play
	Starts the ringback tone playing. More...

(id< ZDKResult >)	- stop
	Stops the playing of the ringback tone. More...

(NSString *)	- handlesDescription

Instance Methods inherited from <ZDKZHandle>
(long int)	- handle

(void)	- initialize

(void)	- releaseReference

(NSString *)	- handlesDescription

Properties
BOOL	enable
	Gets the configured use of ringback tone. More...

id< ZDKSound >	ringBackSound
	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

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

◆ play

- (id< ZDKResult >) 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: ZDKResult, enable()

◆ stop

- (id< ZDKResult >) 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: ZDKResult

Property Documentation

◆ enable

- (BOOL) enable

readwritenonatomicassign

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

- (id<ZDKSound>) ringBackSound

readwritenonatomicassign

Sets the configured ringback sound.

Parameters

[in] value The new ringback sound to be used

See also: ZDKSound

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

Controllers/ZDKRingBackToneControl.h

Instance Methods

Properties