Jump to: navigation, search
(Created page with "= Separate Ringer Volume Control = {{NoteFormat|This feature was introduced as part of the 9.0.011.06 release.}} This...")
 
Line 3: Line 3:
 
{{NoteFormat|This feature was introduced as part of the [[Documentation:RN:sep-sdk-osx90rn:sep-sdk-osx900106|9.0.011.06]] release.}}
 
{{NoteFormat|This feature was introduced as part of the [[Documentation:RN:sep-sdk-osx90rn:sep-sdk-osx900106|9.0.011.06]] release.}}
  
−
This feature allows customers to change the ringer volume without changing the device volume. This decouples the ringer volume control from the device volume control.  
+
This feature allows the application to control ringer volume without affecting the actual output device volume, by scaling the ringtone audio before playing it to the device. The implementation provides both '''set''' and '''get''' methods, and a method to test current volume by playing a fragment of the configured ringtone.
  
−
{{Editgrn_open}}Need more information{{Editgrn_close}}
+
<div class="cloud-tabberlive-wrapper">
 +
<tabber>
 +
 +
OS X=
 +
<div class="cloud-wrapper">
 +
<h2>Overview</h2>
 +
<div class="cloud-left">
 +
The ringer control functionality is included a part of the '''GSEndpoint''' interface.
 +
<pre>
 +
@protocol GSEndpoint <NSObject>
 +
  /**
 +
  Ringer volume scaling, a number between 0 and 100 representing the current scaling,
 +
  with 0 muting the ringtone, 50 meaning "no scaling" (no changes to ringtone volume)
 +
  and 100 meaning "maximum amplification" (volume increased to 2 times louder)
 +
  */
 +
  @property (nonatomic) int ringerVolume;
 +
  /**
 +
  Changes the ringer volume scaling to the specified value.
 +
  @param value a number between 0 and 100 representing the new scaling.
 +
  @returns the result of the operation
 +
  */
 +
  - (GSResult) changeRingerVolumeTo:(int) value;
 +
  /**
 +
  Get the currently used ringer volume.
 +
  @return a number between 0 and 100 representing the current scaling
 +
  */
 +
  - (int) getRingerVolume;
 +
  /**
 +
  Plays configured ringing tone for specified duration (to test volume).
 +
  @param duration of playback in milliseconds.
 +
  @returns the result of the operation
 +
  */
 +
- (GSResult) testRingerPlayback:(int) value;
 +
</pre>
 +
</div>
 +
</div>
 +
 +
|-|
 +
.NET=
 +
<div class="cloud-wrapper">
 +
<h2>Overview</h2>
 +
<div class="cloud-left">
 +
The ringer volume control support has been added as the speaker related method of the '''IExtendedService''' interface.
 +
<pre>
 +
public interface class IExtendedService
 +
  {
 +
    GsStatus SetRingerVolume(int volume);
 +
    int      GetRingerVolume();
 +
    GsStatus TestRingerPlayback(int duration_msec);
 +
  }
 +
</pre>
 +
</div>
 +
</div>
 +
 +
</tabber>
 +
<div style="clear: both;"> </div>
  
  
 
[[Category:V:SESDK:9.0.0OSXDRAFT]]
 
[[Category:V:SESDK:9.0.0OSXDRAFT]]

Revision as of 09:20, December 13, 2018

Separate Ringer Volume Control

Important
This feature was introduced as part of the 9.0.011.06 release.

This feature allows the application to control ringer volume without affecting the actual output device volume, by scaling the ringtone audio before playing it to the device. The implementation provides both set and get methods, and a method to test current volume by playing a fragment of the configured ringtone.

Overview

The ringer control functionality is included a part of the GSEndpoint interface. 

 @protocol GSEndpoint <NSObject>
  /**
   Ringer volume scaling, a number between 0 and 100 representing the current scaling,
   with 0 muting the ringtone, 50 meaning "no scaling" (no changes to ringtone volume)
   and 100 meaning "maximum amplification" (volume increased to 2 times louder)
   */
  @property (nonatomic) int ringerVolume;
  /**
   Changes the ringer volume scaling to the specified value.
   @param value a number between 0 and 100 representing the new scaling.
   @returns the result of the operation
   */
  - (GSResult) changeRingerVolumeTo:(int) value;
  /**
   Get the currently used ringer volume.
   @return a number between 0 and 100 representing the current scaling
   */
  - (int) getRingerVolume;
  /**
   Plays configured ringing tone for specified duration (to test volume).
   @param duration of playback in milliseconds.
   @returns the result of the operation
   */
- (GSResult) testRingerPlayback:(int) value;

Overview

The ringer volume control support has been added as the speaker related method of the IExtendedService interface. 

public interface class IExtendedService
  {
    GsStatus SetRingerVolume(int volume);
    int      GetRingerVolume();
    GsStatus TestRingerPlayback(int duration_msec); 
  }

Comments or questions about this documentation? Contact us for support!