Overview of the interface and its functionalities

• The interface allows you to control audio cues for a theater show.
• It displays a table with information about each audio cue.
• You can control the playback and volume of each audio cue.
• There are hotkeys available for quick access to specific audio cues.
• You can enter fullscreen mode for a better viewing experience.

Interface

Cue Controls

• Use the '＋' and '−' buttons to increase or decrease the volume of each audio cue.
• The '⨁' button increases the volume beyond the allowable maximum volume.
• The '⦒' button triggers a fade-out and stops the audio, proceeding to the next cue.
• The 'F.IN' column indicates the fade-in duration of each audio cue.
• The 'F.OUT' column indicates the fade-out duration of each audio cue.
• The 'PC' column shows the play count, indicating how many times the audio cue will play.
• The 'NC' column represents the next cue action, specifying what should happen after the current audio cue finishes playing.
• The 'CD' column represents the cue delay, specifying the time between cues.

Hotkeys

• Press the number keys (0-9) to play the corresponding audio cue.
• Press the same number key while an audio cue is playing to initiate a fade-out.
• Press the spacebar key to jump tp the next cue.
• Press the F1 key to access help and additional information about the interface.
• Press the Escape (Esc) key to stop all running scripts and return to the default state of the interface. This will halt any ongoing processes or actions.
• Please note that pressing Escape to stop all scripts may have different effects depending on the specific implementation and context in which the interface is being used.

Fullscreen Mode

• To enter fullscreen mode, press the F11 key or click on the 'Current Time' cell.
• To exit fullscreen mode, press the F11 key or click on the 'Current Time' cell once again.

Additional Notes

• Pay attention to cue delays, which indicate the time between cues.
• Monitor the console logs for important messages and status updates.
• The background color of an audio cue's row indicates its current state:
• Grey: The audio cue has already played and now it's stopped.
• Yellow: The audio cue is fading in or fading out.
• Green: The audio cue is playing.
• Red: An error has been encountered.

Configuration File [audio-show.js]

Audio Show [audioShow]

Configuration Fields

var audioShow = {
    name: "",
    version: "",
    updated: ""
};

Name [audioShow.name]

• This field should contain the name or title of the show for which the audio is intended.
• Provide a clear and concise name that represents the show.

Version [audioShow.version]

• Use this field to specify the version number of the show's audio cues.
• This can be useful for tracking changes and updates to the audio files.
• You can use any numbering system that suits your needs, such as sequential numbers or semantic versioning.

Updated [audioShow.updated]

• This field should indicate the date when the audio cues for the show were last updated or modified.
• Use a clear date format, such as YYYY-MM-DD or DD-MM-YYYY, to avoid confusion.

Audio Cues [audioCues]

Configuration Fields

var audioCues = [
    {
        fileName: "",
        volume: 0,
        fadeInDuration: 0,
        fadeOutDuration: 0,
        sceneName: "",
        cueIn: "",
        cueOut: "",
        playCount: "",
        nextCue: "",
        cueDelay: 0,
        hotKey: "",
    }
];

Overall

• fileName: Specify the file name of the audio with extension (e.g., ambience.m4a)
• volume: Set the desired volume for the audio (0-100)
• fadeInDuration: Set the duration of the fade-in effect in seconds
• fadeOutDuration: Set the duration of the fade-out effect in seconds
• sceneName: Provide the name of the scene associated with the audio
• cueIn: Optionally, provide any details or notes about the cue-in of the audio (if applicable)
• cueOut: Optionally, provide any details or notes about the cue-out of the audio (if applicable)
• playCount: Specify the number of times the audio should play (e.g., "loop" for continuous looping)
• nextCue: Specify the action to be taken after this audio cue finishes (e.g., "playNext" for playing the next cue)
• cueDelay: Set the delay time in seconds before playing the next cue (if applicable)
• hotKey: Assign a hotkey for quick access to this audio cue (if desired).

Filename [audioCues.fileName]

• The "fileName" field specifies the name of the audio file associated with the audio cue.
• Provide the file name along with the file extension (e.g., "audio.mp3", "music.wav", "sound.ogg").
• Make sure the audio file is located in the correct directory or path accessible to your application.
• Verify that the file name is spelled correctly and matches the actual file name in your file system.
• It's important to ensure that the "fileName" field accurately references the audio file you want to use for each audio cue.

Volume [audioCues.volume]

• The "volume" field determines the playback volume of the audio cue.
• Specify the volume as a percentage value ranging from 0 to 100.
• A value of 0 represents complete silence (muted), while a value of 100 indicates the maximum olume.
• Adjust the volume based on your desired audio level for each specific cue.
• Experiment with different volume settings to achieve the desired audio balance within your application.
• Remember to consider the overall audio experience and adjust the volume of each cue accordingly, ensuring that it fits well with the other elements of your application.

Fade In Duration [audioCues.fadeinDuration]

• The "fadeInDuration" field specifies the duration of the fade-in effect for the audio cue.
• It represents the time it takes for the audio to transition from silence to its designated volume.
• The duration is measured in seconds.
• A shorter duration will result in a quicker fade-in, while a longer duration will create a slower and more gradual fade-in effect.
• Adjust the fade-in duration based on the desired effect and timing for each specific audio cue.
• Experiment with different fade-in durations to find the optimal balance between a smooth transition and the desired impact of the audio cue.
• Consider the pacing and timing of your application to determine the appropriate fade-in duration for each audio cue, ensuring that it aligns with the desired user experience.

Fade Out Duration [audioCues.fadeOutDuration]

• The "fadeOutDuration" field specifies the duration of the fade-out effect for the audio cue.
• It represents the time it takes for the audio to transition from its current volume to silence.
• The duration is measured in seconds.
• A shorter duration will result in a quicker fade-out, while a longer duration will create a slower and more gradual fade-out effect.
• Adjust the fade-out duration based on the desired effect and timing for each specific audio cue.
• Consider the length and nature of the audio cue when determining the fade-out duration. Shorter cues may require shorter fade-outs, while longer cues may benefit from longer fade-outs.
• Experiment with different fade-out durations to find the optimal balance between a smooth transition and the desired impact of the audio cue.
• Take into account the overall flow and desired audio experience of your application to determine the appropriate fade-out duration for each audio cue.

Scene Name [audioCues.sceneName]

• The "sceneName" field represents the name or description of the scene associated with the audio cue.
• It is used to provide context or identify the specific scene or setting where the audio cue should be played.
• Enter a descriptive name or label that helps you easily identify and associate the audio cue with the corresponding scene.
• The scene name can be a word, phrase, or short description that reflects the content or purpose of the audio cue within the scene.
• Use consistent and meaningful scene names to maintain clarity and organization in your audio cues.
• Consider the overall structure and narrative of your audio playback to ensure that the scene names accurately represent the intended scenes or sections.
• By providing clear and descriptive scene names, you can effectively organize and manage your audio cues, making it easier to navigate and control the playback of specific cues within the corresponding scenes.

Cue In [audioCues.cueIn]

• The "cueIn" field is used to provide additional details or notes about the cue-in of the audio cue.
• It allows you to include specific instructions, cues, or information related to the audio cue's entrance or beginning.
• Use this field to describe any special timing, effects, or actions that should accompany the start of the audio cue.
• Include relevant information about how the cue should be executed, such as specific sound effects, lighting changes, or stage directions.
• If there are any specific cues or events in the performance that need to align with the audio cue's entrance, mention them in the "cueIn" field.
• Add any important notes or reminders for the technical crew or performers related to the audio cue's introduction.
• Ensure that the information provided in the "cueIn" field is clear, concise, and easy to understand for everyone involved in the production.
• By using the "cueIn" field effectively, you can communicate important details and instructions related to the cue-in of the audio cues, facilitating smooth and coordinated performances.

Cue Out [audioCues.cueOut]

• The "cueOut" field is used to provide additional details or notes about the cue-out of the audio cue.
• It allows you to include specific instructions, cues, or information related to the audio cue's exit or ending.
• Use this field to describe any special timing, effects, or actions that should accompany the end of the audio cue.
• Include relevant information about how the cue should be concluded, such as fade-outs, lingering effects, or stage directions.
• If there are any specific cues or events in the performance that need to align with the audio cue's exit, mention them in the "cueOut" field.
• Add any important notes or reminders for the technical crew or performers related to the audio cue's conclusion.
• Ensure that the information provided in the "cueOut" field is clear, concise, and easy to understand for everyone involved in the production.
• By using the "cueOut" field effectively, you can communicate important details and instructions related to the cue-out of the audio cues, ensuring a seamless and coordinated performance.

Play Count [audioCues.playCount]

• The "playCount" field specifies the number of times the audio cue should play.
• There are several options you can use for the "playCount" field.
• "a positive integer" : You can specify a specific number (e.g., 1, 2, 3, etc.) to indicate the exact number of times the audio cue should play.
• "loop" : This option indicates that the audio cue should loop continuously until manually stopped. The cue will repeat indefinitely.
• It's important to choose the appropriate "playCount" option based on your desired playback behavior. If you want the cue to play a specific number of times or loop indefinitely, specify the corresponding value.

Next Cue [audioCues.nextCue]

• The "nextCue" field specifies the action to be taken after the current audio cue finishes playing.
• There are several options you can use for the "nextCue" field.
• "playNext" : This option indicates that the next audio cue in the sequence should be played automatically after the current one finishes.
• "" : A blank value indicates that the audio playback should stop after the current cue finishes.
• Make sure to choose the appropriate "nextCue" option based on the desired behavior and sequencing of your audio cues.

Cue Delay [audioCues.cueDelay]

• The "cueDelay" field represents the time delay between audio cues in seconds.
• To set a specific cue delay for an audio cue, enter the desired time duration in seconds.
• The cue delay determines how long the application waits before playing the next audio cue.
• Use a numerical value to specify the cue delay (e.g., 2, 5, 10).
• Leave the "cueDelay" field empty or set it to 0 if you want the next audio cue to play immediately after the current one finishes.
• If you want to create a crossfade effect between two audio cues, you can use negative values for the cue delay. The absolute value represents the duration of the crossfade.
• Remember to adjust the cue delay according to the timing and synchronization requirements of your audio cues.

Hotkeys [audioCues.hotKey]

• If you want to assign a specific hotkey to an audio cue, enter the desired key in the "HotKey" field.
• Use a single letter or a character to represent the hotkey (e.g., 'A', 'B', 'C', '@', '#', '$').
• Make sure the hotkey is unique and not already assigned to another audio cue.
• Leave the "HotKey" field empty if you don't want to assign a hotkey to the audio cue.
• If all hotkeys are already assigned, a default hotkey will be automatically assigned to the audio cue.
• The default hotkey will be selected from the available set of characters (e.g., 'Q', 'W', 'E', 'R').
• Remember to ensure that the assigned hotkeys are easy to remember and don't conflict with any existing key bindings or functionality within your application.

Venue Notes

• Make sure to follow the instructions provided by the theater staff.
• Do not use cellphones or any other sound-emitting devices during the show.
• Photography, video recording, and sound recording are strictly prohibited.
• Enjoy the show and thank you for your cooperation!

Usage Disclaimer

Demo Audio Files

1. License : The audio files are licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) license. This license permits the user to freely use, modify, and distribute the audio files, even for commercial purposes, as long as proper attribution is given to the original creators.
2. Attribution : When using the audio files, you must provide appropriate credit to the original creators by including their names or any other information they have requested for attribution.
3. Limitations : The audio files are provided "as is" without any warranties or guarantees of any kind, whether expressed or implied. The software developers shall not be held liable for any damages or losses arising from the use of these audio files.
4. Compliance : You are responsible for ensuring compliance with any applicable laws, regulations, or licensing requirements when using the audio files. It is your responsibility to obtain any necessary permissions or clearances for your specific use case.