aiovlc package

Control VLC over telnet connection using asyncio.

Subpackages

• aiovlc.model package
  • Submodules
  • aiovlc.model.command module
    • Add
      • Add.build_command()
      • Add.playlist_item
      • Add.prefix
    • Clear
      • Clear.prefix
    • Command
      • Command.build_command()
      • Command.log_command
      • Command.parse_output()
      • Command.prefix
      • Command.read_terminator
      • Command.send()
    • CommandOutput
    • Enqueue
      • Enqueue.build_command()
      • Enqueue.playlist_item
      • Enqueue.prefix
    • GetLength
      • GetLength.parse_output()
      • GetLength.prefix
    • GetLengthOutput
      • GetLengthOutput.length
    • GetTime
      • GetTime.parse_output()
      • GetTime.prefix
    • GetTimeOutput
      • GetTimeOutput.time
    • Info
      • Info.parse_output()
      • Info.prefix
    • InfoOutput
      • InfoOutput.data
    • Next
      • Next.prefix
    • Password
      • Password.build_command()
      • Password.log_command
      • Password.parse_output()
      • Password.password
      • Password.prefix
      • Password.read_terminator
      • Password.send()
    • PasswordOutput
      • PasswordOutput.response
    • Pause
      • Pause.prefix
    • Play
      • Play.prefix
    • Prev
      • Prev.prefix
    • Random
      • Random.VALID_MODES
      • Random.build_command()
      • Random.mode
      • Random.prefix
    • Seek
      • Seek.build_command()
      • Seek.prefix
      • Seek.seconds
    • SetVolume
      • SetVolume.VALID_VOLUME
      • SetVolume.build_command()
      • SetVolume.prefix
      • SetVolume.volume
    • Status
      • Status.parse_output()
      • Status.prefix
    • StatusOutput
      • StatusOutput.audio_volume
      • StatusOutput.input_loc
      • StatusOutput.state
    • Stop
      • Stop.prefix
    • Volume
      • Volume.parse_output()
      • Volume.prefix
    • VolumeOutput
      • VolumeOutput.audio_volume

Submodules

aiovlc.cli module

aiovlc.client module

Provide a client for aiovlc.

class aiovlc.client.Client(password: str, host: str = 'localhost', port: int = 4212, timeout: int = 10)

Bases: object

Represent a client for aiovlc.

async add(playlist_item: str) → None

Send the add command.

async clear() → None

Send the clear command.

async connect() → None

Connect the client.

async disconnect() → None

Disconnect the client.

async enqueue(playlist_item: str) → None

Send the enqueue command.

async get_length() → GetLengthOutput

Send the get_length command.

async get_time() → GetTimeOutput

Send the get_time command.

async info() → InfoOutput

Send the info command.

async login() → PasswordOutput

Login.

async next() → None

Send the next command.

async pause() → None

Send the pause command.

async play() → None

Send the play command.

async prev() → None

Send the prev command.

async random(mode: Literal['on', 'off'] | None = None) → None

Send the random command.

async read(read_until: str = '\n') → str

Return a decoded message.

async seek(seconds: int) → None

Send the seek command.

async set_volume(volume: int) → None

Send the volume command with a parameter to set volume.

async status() → StatusOutput

Send the status command.

async stop() → None

Send the stop command.

async volume() → VolumeOutput

Send the volume command.

async write(command: str) → None

Write a command to the connection.

aiovlc.const module

Provide common constants.

aiovlc.exceptions module

Provide exceptions for aiovlc.

exception aiovlc.exceptions.AIOVLCError

Bases: Exception

Represent a common error for aiovlc.

exception aiovlc.exceptions.AuthError

Bases: AIOVLCError

Represent an authentication error.

exception aiovlc.exceptions.CommandError

Bases: AIOVLCError

Represent a command error.

exception aiovlc.exceptions.CommandParameterError

Bases: CommandError

Represent an error with a parameter when calling the command.

exception aiovlc.exceptions.CommandParseError

Bases: CommandError

Represent an error when parsing the command output.

exception aiovlc.exceptions.ConnectError

Bases: AIOVLCError

Represent a connection error for aiovlc.

exception aiovlc.exceptions.ConnectReadError(error: Exception, partial_bytes: bytes | None = None)

Bases: ConnectError

The client failed to read.