PMMS API and exports

Goal: drive PMMS from your own resources. Where: in the code of your resources, started after pmms.

Handles

Each active media player is identified by a handle:

• networked entity: its network ID (NetworkGetNetworkIdFromEntity);
• local entity or position: a hash computed from the coordinates rounded to a tenth.

Start exports return this handle; keep it for stop, pause, lock… pmms_ctl list (server console) shows the active handles.

Server exports

Server exports check no permission and are not subject to Config.oneMediaPerPlayer. Every export start is sent to the Discord logs as “Lancement serveur/export”. stop, pause, lock, unlock, mute and unmute expect an active handle: check it with getMediaPlayerInfo before calling.

getAllMediaPlayers and getMediaPlayerInfo return the tables the server uses: read them without modifying them.

Playback options

options table of the start exports, presets and default media players:

Example: vehicle radio

Server side, in your resource (my_garage is an example):

RegisterNetEvent('my_garage:radio', function(netId, url)
    local src = source
    if not IsPlayerAceAllowed(src, 'pmms.interact') then
        return
    end

    local entity = NetworkGetEntityFromNetworkId(netId)
    if entity == 0 or #(GetEntityCoords(GetPlayerPed(src)) - GetEntityCoords(entity)) > 5.0 then
        return
    end

    local current = exports.pmms:getMediaPlayerInfo(netId)
    if current then
        exports.pmms:stop(netId)
    end

    exports.pmms:startByNetworkId(netId, {
        url = url,
        title = 'Radio',
        volume = 70,
        filter = false,
        range = 25
    })
end)

Result: the vehicle radio plays the URL for every player within 25 m. The permission and distance checks are done by your event, since the export does none. Also validate url according to your rules.

Example: personal speaker

Client side:

local speaker

RegisterCommand('speaker', function()
    if speaker then
        exports.pmms:deleteMediaPlayer(speaker)
        speaker = nil
        return
    end

    local ped = PlayerPedId()
    speaker = exports.pmms:createMediaPlayer({
        model = `prop_boombox_01`,
        position = GetOffsetFromEntityInWorldCoords(ped, 0.0, 0.8, -0.95),
        rotation = vector3(0.0, 0.0, GetEntityHeading(ped))
    })
end)

Result: /speaker drops a speaker in front of the player; it shows in their panel even without pmms.anyEntity, and disappears when pmms stops or on the second call.

Client exports

Events

The pmms:* events are used for internal communication between client, server and interface. They are not a public API: use the exports.

Common mistakes

• “No such export”: pmms is not started, or your resource starts before it.
• Lua error on stop or lock: the handle matches no active player.
• Media that never stops: duration absent, the media is treated as a live stream; loop and queue do not work either.
• Unexpected radio effect: filter missing from the options (see Troubleshooting).