View Single Post in: Sims 3 Script Extender Overview
#4
23rd Apr 2021 at 10:20 PM
23rd Apr 2021 at 10:20 PM
Posts: 436
Thanks: 976 in 6 Posts
Audio / Sound:
Battery.S3SE.Audio
MusicStatus GetMusicStatus()
Usage: Returns the enum MusicStatus to determine the status of S3SE Music
Example:
void Music_NextPlaylistSong()
Usage: This method skips the currently playing song in the S3SE playlist
Example:
void Music_SetPlaylist(string[] PlaylistPaths)
Usage: Set the Music playlist by providing an array of all the mp3 audio file paths
Example:
void PauseMP3Music()
Usage: Pauses the currently playing mp3
Example:
void PlayMP3Music(string path)
Usage: Starts to play the mp3 file in the given path
Example:
void PlayWav(string path)
Usage: Starts to play the Wav file in the given path
Example:
void PlayWav(string path, bool loop)
Usage: Starts to play the Wav file in the given path with the option to loop until either the sound is stopped or another soundfile is played
Example:
void ResumeMP3Music()
Usage: Resumes paused S3SE music
Example:
void SetVolumeMP3Music(ushort Volume = 100)
Usage: Sets the volume of the mp3 music min = 0 max = 1000
Example:
void SetVolumeMP3Music(ushort Volume = 100)
Usage: Sets the volume of the mp3 music min = 0 max = 1000
Example:
void SetVolumeMP3Music(stringVolume = "100")
Usage: Sets the volume of the mp3 music min = "0" max = "1000"
Example:
void StopMP3Music()
Usage: Stops the currently playing music
Example:
Battery.S3SE.Audio
MusicStatus GetMusicStatus()
Usage: Returns the enum MusicStatus to determine the status of S3SE Music
Example:
Code:
public static MusicStatus GetMusicStatus()
{
if(Battery.S3SE.IsInitialized())
{
return Battery.S3SE.Audio.GetMusicStatus();
}
return MusicStatus.Stopped
}
void Music_NextPlaylistSong()
Usage: This method skips the currently playing song in the S3SE playlist
Example:
Code:
public static void SkipSong()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.Music_NextPlaylistSong();
}
}
void Music_SetPlaylist(string[] PlaylistPaths)
Usage: Set the Music playlist by providing an array of all the mp3 audio file paths
Example:
Code:
public static void SetPlaylist()
{
if(Battery.S3SE.IsInitialized())
{
string[] playlistpaths = new string[]
{
@"C:\MyMusic\Song1.mp3",
@"C:\MyMusic\Song2.mp3",
@"C:\MyMusic\Song3.mp3",
@"C:\MyMusic\Song4.mp3"
};
Battery.S3SE.Audio.Music_SetPlaylist(playlistpaths);
}
}
void PauseMP3Music()
Usage: Pauses the currently playing mp3
Example:
Code:
public static void PauseMusicAndPlaylist()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.PauseMP3Music();
}
}
void PlayMP3Music(string path)
Usage: Starts to play the mp3 file in the given path
Example:
Code:
public static void PlayFavoriteSong()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.PlayMP3Music(@"C:/BestSongsEVER/Never Gonna Give You Up.mp3");
}
}
void PlayWav(string path)
Usage: Starts to play the Wav file in the given path
Example:
Code:
public static void PlayFavoriteSong()
public static void PlayFavoriteWav()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.PlayWav(@"C:/SoundEffects/RRoll.wav");
}
}
void PlayWav(string path, bool loop)
Usage: Starts to play the Wav file in the given path with the option to loop until either the sound is stopped or another soundfile is played
Example:
Code:
public static void PlayFavoriteSong()
public static void PlayFavoriteWavEndlessly()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.PlayWav(@"C:/SoundEffects/RRoll.wav", true);
}
}
void ResumeMP3Music()
Usage: Resumes paused S3SE music
Example:
Code:
public static void ResumeMusicAndPlaylist()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.ResumeMP3Music();
}
}
void SetVolumeMP3Music(ushort Volume = 100)
Usage: Sets the volume of the mp3 music min = 0 max = 1000
Example:
Code:
public static void SetVolumeTo50Percent()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.SetVolumeMP3Music(500);
}
}
void SetVolumeMP3Music(ushort Volume = 100)
Usage: Sets the volume of the mp3 music min = 0 max = 1000
Example:
Code:
public static void SetVolumeTo50Percent()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.SetVolumeMP3Music(500);
}
}
void SetVolumeMP3Music(stringVolume = "100")
Usage: Sets the volume of the mp3 music min = "0" max = "1000"
Example:
Code:
public static void SetVolumeTo50Percent()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.SetVolumeMP3Music("500");
}
}
void StopMP3Music()
Usage: Stops the currently playing music
Example:
Code:
public static void StopMusic()
{
if(Battery.S3SE.IsInitialized())
{
Battery.S3SE.Audio.StopMP3Music();
}
}