PlayAudioStreamForPlayer

PlayAudioStreamForPlayer

Description:

Function PlayAudioStreamForPlayer play an 'audio stream' for a player. Normal audio files also work (e.g. MP3).

Function PlayAudioStreamForPlayer was added in 0.3d and will not work in earlier versions!

Parameters:

(playerid, url[], Float:posX = 0.0, Float:posY = 0.0, Float:posZ = 0.0, Float:distance = 50.0, usepos = 0)

int

playerid

The ID of the player to play the audio for.

string

url

The url to play. Valid formats are mp3 and ogg/vorbis. A link to a .pls (playlist) file will play that playlist.

float

posX

The X position at which to play the audio. Default 0.0. Has no effect unless usepos is set to 1.

float

posY

The Y position at which to play the audio. Default 0.0. Has no effect unless usepos is set to 1.

float

posZ

The Z position at which to play the audio. Default 0.0. Has no effect unless usepos is set to 1.

float

distance

The distance over which the audio will be heard. Has no effect unless usepos is set to 1.

bool

usepos

Use the positions and distance specified. Default disabled (0).

Return Values:

• 1: The function was executed successfully.
• 0: The function failed to execute. The player specified does not exist.

Examples:

Example 1

public OnPlayerCommandText(playerid, cmdtext[])
{
    if (strcmp("/radio", cmdtext, true) == 0) 
    {
        PlayAudioStreamForPlayer(playerid, "http://somafm.com/tags.pls");
        return 1;
    }
    if (strcmp("/radiopos", cmdtext, true) == 0)
    {
        new Float:X, Float:Y, Float:Z, Float:Distance = 5.0;
        GetPlayerPos(playerid, X, Y, Z);
	PlayAudioStreamForPlayer(playerid, "http://somafm.com/tags.pls", X, Y, Z, Distance, 1);
	return 1;
    }
    return 0;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• StopAudioStreamForPlayer: Stops the current audio stream for a player.
• PlayerPlaySound: Play a sound for a player.