pycaspar package

Submodules

pycaspar.channel module

class pycaspar.channel.Channel(caspar_instance, channel_id)

clear()

Clear channel and all layers on channel.

framerate

Query server and return the frame rate of the channel.

id

Get channel integer id as used by Caspar internally.

layer(layer_id)

Get a Caspar Layer object for the given numeric layer ID :param int layer_id: Layer ID

name

pycaspar.layer module

class pycaspar.layer.Layer(caspar_instance, channel_id, layer_id)

Create a Caspar Layer object.

Parameters:caspar_instance (pycaspar.CasparCG) – Caspar instance

clear()

Clears layer by sending a CLEAR command.

id

Get layer integer id as used by Caspar internally.

name

Return the Caspar-internal name for the current layer.

play(filename, transition=None, loop=False, seek=False)

Play a given resource on the layer.

Parameters:

• filename (str) – Filename or URI to play
• transition (str) – Transition string (see https://github.com/CasparCG/help/wiki/AMCP-Protocol#loadbg for definition)
• loop (bool) – Causes the file to play indefinitely.
• seek (int) – Seek seek seconds into file before playing

Module contents

class pycaspar.CasparCG(hostname, amcp_port=5250)

Open a connection to a CasparCG instance.

Parameters:

• hostname (string) – Host name of Caspar server.
• amcp_port (int) – Port number for AMCP connection.

channel(channel_id)

Create and return a Channel object corresponding to channel ID number.

Parameters:channel_id (int) – Channel ID number.

channels

Query the server and return a list of channels.

layer(channel_id, layer_id)

Create and return a Layer object corresponding to channel and layer ID numbers.

Parameters:

• channel_id (int) – Channel ID number.
• layer_id (int) – Layer ID number.

layers

Query the server and return a list of layers.