Function encode_track

lavalink/utils.py:231–277

Encodes a track dict into a base64 string, readable by the Lavalink server. A track should have *at least* the following keys: ``title``, ``author``, ``length``, ``identifier``, ``isStream``, ``uri``, ``sourceName`` and ``position``. If the track is a v3 track, it should have the

(track: Dict[str, Any],
                 source_encoders: Mapping[str, Callable[[DataWriter, Dict[str, Any]], None]] = MISSING)

def encode_track(track: Dict[str, Any],
                 source_encoders: Mapping[str, Callable[[DataWriter, Dict[str, Any]], None]] = MISSING) -> Tuple[int, str]:
    """
    Encodes a track dict into a base64 string, readable by the Lavalink server.

    A track should have *at least* the following keys:
    ``title``, ``author``, ``length``, ``identifier``, ``isStream``, ``uri``, ``sourceName`` and ``position``.

    If the track is a v3 track, it should have the following additional fields:
    ``artworkUrl`` and ``isrc``. isrc can be ``None`` if not applicable.

    Parameters
    ----------
    track: Dict[str, Union[Optional[str], int, bool]]
        The track dict to serialize.
    source_encoders: Mapping[:class:`str`, Callable[[:class:`DataWriter`]]
        A mapping of source-specific encoders to use.
        Some Lavaplayer sources have additional fields encoded on a per-source manager basis, so you can
        specify a mapping of encoders that will handle encoding these additional fields. This isn't required
        for all sources, so ensure that you need them before specifying.

        The mapping must be in the format of something like ``{'http': http_encoder_function}``, where the
        key ``str`` is the name of the source. These functions will only be called if track's ``sourceName``
        field matches.

    Raises
    ------
    :class:`InvalidTrack`
        If the track has unexpected, or missing keys, possibly due to an incompatible version or another reason.

    Returns
    -------
    Tuple[int, str]
        A tuple containing (track_version, encoded_track).
        For example, if a track was encoded as version 3, the return value will be ``(3, '...really long track string...')``.
    """
    track_keys = track.keys()  # set(track) is faster for larger collections, but slower for smaller.

    if not V2_KEYSET <= track_keys:  # V2_KEYSET contains the minimum number of fields required to successfully encode a track.
        missing_keys = [k for k in V2_KEYSET if k not in track]

        raise InvalidTrack(f'Track object is missing keys required for serialization: {", ".join(missing_keys)}')

    if V3_KEYSET <= track_keys:
        return (3, encode_track_v3(track, source_encoders))

    return (2, encode_track_v2(track, source_encoders))


def encode_track_v2(track: Dict[str, Any],