mobileSetSoundChannelVolume

Typecommand
DictionaryLCS
LibraryLiveCode Script
Syntax
mobileSetSoundChannelVolume <channel>, <volume>
Synonymsiphonesetsoundchannelvolume
Summary

Sets the volume of a sound channel.

Introduced4.6
OSios, android
Platformsmobile
Parameters
NameTypeDescription
channel

The name of the channel.

volume

An integer between 1 and 100 where 0 is no volume and 100 is full volume.

Example
mobileSetSoundChannelVolume theChannel, theVolume
mobileSetSoundChannelVolume "current", 50
RelatedCommand: mobileDeleteSoundChannel, mobilePlaySoundOnChannel, mobilePausePlayingOnChannel, mobileStopPlayingOnChannel, mobileResumePlayingOnChannel
Function: mobileSoundChannelVolume, mobileSoundOnChannel, mobileNextSoundOnChannel, mobileSoundChannels, mobileSoundChannelStatus
Message: soundFinishedOnChannel
Description

Use the mobileSetSoundChannelVolume command to control the volume of the given channel.

Changing the volume of a channel affects the currently playing sound and any sounds played subsequently on the channel.

Setting the volume of a non-existent channel results in it being created. This allows the volume to be set before any sounds are played.