com.zoiper.zdk.Controllers

Class RingBackToneControl

java.lang.Object

com.zoiper.zdk.Controllers.RingBackToneControl

public class RingBackToneControl
extends java.lang.Object

Ringback tone's main entry point Entry point for controlling the ringback tone heard by the user when the remote peer starts ringing

Constructor Summary

Constructors

Constructor and Description
RingBackToneControl(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
boolean	enable() Configures the use of ringback tone Whether ringback tones can be played or not.
void	enable(boolean value) Gets the configured use of ringback tone Whether ringback tones can be played or not.
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
Result	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.
Sound	ringBackSound() Gets the configured ringback sound
void	ringBackSound(Sound value) Sets the configured ringback sound
Result	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.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RingBackToneControl

public RingBackToneControl(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

enable

public boolean enable()

Configures the use of ringback tone Whether ringback tones can be played or not. ENABLED by default!

Returns:

• 0 - disabled
• 1 - enabled

enable

public void enable(boolean value)

Gets the configured use of ringback tone Whether ringback tones can be played or not. ENABLED by default!

Parameters:

value -

• 0 - disabled
• 1 - enabled

ringBackSound

public Sound ringBackSound()

Gets the configured ringback sound

Returns:

The configured ringback sound

See Also:

Sound

ringBackSound

public void ringBackSound(Sound value)

Sets the configured ringback sound

Parameters:

value - The new ringback sound to be used

See Also:

Sound

play

public Result 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:

enable

stop

public Result 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