MLVolume Plugin

From Cinemar Wiki
Jump to: navigation, search

About

This plug-in handles volume adjustments and writes out variables for the volume levels and mute status.

Software Requirements

  • MLServer
  • MLVolume Plugin

Supported Hardware

  • Sound Card

Supported Commands

WaveVolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|WaveVolumeUp


(Literal)

MLServeCmd.MLVolume|WaveVolumeUp


Parameters
none =


Description

Increases the wave volume.


WaveVolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|WaveVolumeDown


(Literal)

MLServeCmd.MLVolume|WaveVolumeDown


Parameters
none =


Description

Decreases the wave volume.


WaveToggleMute

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|WaveToggleMute


(Literal)

MLServeCmd.MLVolume|WaveToggleMute


Parameters
none =


Description

Toggles the wave mute.


SetWaveVolume

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|SetWaveVolume~Volume


(Literal)

MLServeCmd.MLVolume|SetWaveVolume~25

MLServeCmd.MLVolume|SetWaveVolume~60


Parameters
Volume = Volume Level (0..100)


Description

Sets the wave volume to a specified level.


WaveInVolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|WaveInVolumeUp


(Literal)

MLServeCmd.MLVolume|WaveInVolumeUp


Parameters
none =


Description

Increases the wave In volume.


WaveInVolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|WaveInVolumeDown


(Literal)

MLServeCmd.MLVolume|WaveInVolumeDown


Parameters
none =


Description

Decreases the wave In volume.


WaveInToggleMute

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|WaveInToggleMute


(Literal)

MLServeCmd.MLVolume|WaveInToggleMute


Parameters
none =


Description

Toggles the wave In mute.


SetWaveInVolume

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|SetWaveInVolume~Volume


(Literal)

MLServeCmd.MLVolume|SetWaveInVolume~25

MLServeCmd.MLVolume|SetWaveInVolume~60


Parameters
Volume = Volume Level (0..100)


Description

Sets the wave In volume to a specified level.


LineInVolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|LineInVolumeUp


(Literal)

MLServeCmd.MLVolume|LineInVolumeUp


Parameters
none =


Description

Increases the Line In volume.


LineInVolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|LineInVolumeDown


(Literal)

MLServeCmd.MLVolume|LineInVolumeDown


Parameters
none =


Description

Decreases the Line In volume.


LineInToggleMute

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|LineInToggleMute


(Literal)

MLServeCmd.MLVolume|LineInToggleMute


Parameters
none =


Description

Toggles the Line In mute.


SetLineInVolume

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|SetLineInVolume~Volume


(Literal)

MLServeCmd.MLVolume|SetLineInVolume~25

MLServeCmd.MLVolume|SetLineInVolume~60


Parameters
Volume = Volume Level (0..100)


Description

Sets the Line In volume to a specified level.


MicVolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|MicVolumeUp


(Literal)

MLServeCmd.MLVolume|MicVolumeUp


Parameters
none =


Description

Increases the Mic volume.


MicVolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|MicVolumeDown


(Literal)

MLServeCmd.MLVolume|MicVolumeDown


Parameters
none =


Description

Decreases the Mic volume.


MicToggleMute

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|MicToggleMute


(Literal)

MLServeCmd.MLVolume|MicToggleMute


Parameters
none =


Description

Toggles the Mic mute.


SetMicVolume

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|SetMicVolume~Volume


(Literal)

MLServeCmd.MLVolume|SetMicVolume~25

MLServeCmd.MLVolume|SetMicVolume~60


Parameters
Volume = Volume Level (0..100)


Description

Sets the Mic volume to a specified level.


CDVolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|CDVolumeUp


(Literal)

MLServeCmd.MLVolume|CDVolumeUp


Parameters
none =


Description

Increases the CD volume.


CDVolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|CDVolumeDown


(Literal)

MLServeCmd.MLVolume|CDVolumeDown


Parameters
none =


Description

Decreases the CD volume.


CDToggleMute

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|CDToggleMute


(Literal)

MLServeCmd.MLVolume|CDToggleMute


Parameters
none =


Description

Toggles the CD mute.


SetCDVolume

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|SetCDVolume~Volume


(Literal)

MLServeCmd.MLVolume|SetCDVolume~25

MLServeCmd.MLVolume|SetCDVolume~60


Parameters
Volume = Volume Level (0..100)


Description

Sets the CD volume to a specified level.


MIDIVolumeUp

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|MIDIVolumeUp


(Literal)

MLServeCmd.MLVolume|MIDIVolumeUp


Parameters
none =


Description

Increases the MIDI volume.


MIDIVolumeDown

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|MIDIVolumeDown


(Literal)

MLServeCmd.MLVolume|MIDIVolumeDown


Parameters
none =


Description

Decreases the MIDI volume.


MIDIToggleMute

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|MIDIToggleMute


(Literal)

MLServeCmd.MLVolume|MIDIToggleMute


Parameters
none =


Description

Toggles the MIDI mute.


SetMIDIVolume

{MLServeCmd}Script Usage

MLServeCmd.MLVolume|SetMIDIVolume~Volume


(Literal)

MLServeCmd.MLVolume|SetMIDIVolume~25

MLServeCmd.MLVolume|SetMIDIVolume~60


Parameters
Volume = Volume Level (0..100)


Description

Sets the MIDI volume to a specified level.


Variables

  • CDMute
  • CDVolume
  • LineInMute
  • LineInVolume
  • MicropohoneMute
  • MicrophoneVolume
  • MidiMute
  • MidiVolume
  • WaveInMute
  • WaveInVolume
  • WaveMute
  • WaveVolume