Inside Macintosh: Telephony /

Chapter 2 - Telephone Terminals / Telephone Terminals Reference

Telephone Terminals Functions / Monitoring and Controlling Telephone Terminals

TELSetVolume

Sets the volume and state of a terminal device.

pascal TELErr TELSetVolume (
                     TELHandle hTEL, 
                     short volType, 
                     short *level, 
                     short volState);

hTEL

A handle to a telephone record associated with a telephone terminal.

volType

The type of terminal device. See "Volume Controls" on page 2-12 for a description of the device types that have a volume and state.

level

On entry, a value that indicates the desired volume level of the specified terminal device. On exit, a value that indicates the actual volume level of that device.

volState

A value that indicates the desired volume state of the specified terminal device. See "Volume Controls" on page 2-12 for a description of the available volume states.

function result

A result code.

DESCRIPTION

The TELSetVolume function sets the volume level and state of the terminal device specified by the volType and hTEL parameters to the values specified in the level and volState parameters. The value specified in the level parameter should be between telVolMin and telVolMax. You can also pass the value telVolSame to have the volume remain at its current level. The value specified in the volState parameter should be either telVolStateOn or telVolStateOff. You can also pass the value telVolStateSame to have the device remain in its current state.

Different telephone tools may support different maximum volume levels. To determine the maximum volume level supported by a particular tool, pass telVolMax in the level parameter and then inspect the value returned by TELSetVolume in the level parameter.

SPECIAL CONSIDERATIONS

Some terminals might not support the TELSetVolume function.