virtucamera.VCBase Scene State Methods - shycats/PyVirtuCamera GitHub Wiki

• get_playback_state( vcserver )
• get_playback_fps( vcserver )
• set_frame( vcserver, frame )
• set_playback_range( vcserver, start, end )
• start_playback( vcserver, forward )
• stop_playback( vcserver )

---

get_playback_state( vcserver )

Must Return the playback state of the scene as a tuple or list
in the following order: (current_frame, range_start, range_end)
* current_frame (float) - The current frame number.
* range_start (float) - Animation range start frame number.
* range_end (float) - Animation range end frame number.

Parameters
----------
vcserver : virtucamera.VCServer object
    Instance of virtucamera.VCServer calling this method.

Returns
-------
tuple or list of 3 floats
    playback state as (current_frame, range_start, range_end)

get_playback_fps( vcserver )

Must return a float value with the scene playback rate
in Frames Per Second.

Parameters
----------
vcserver : virtucamera.VCServer object
    Instance of virtucamera.VCServer calling this method.

Returns
-------
float
    scene playback rate in FPS.

set_frame( vcserver, frame )

Must set the current frame number on the scene

Parameters
----------
vcserver : virtucamera.VCServer object
    Instance of virtucamera.VCServer calling this method.
frame : float
    The current frame number.

set_playback_range( vcserver, start, end )

Must set the animation frame range on the scene

Parameters
----------
vcserver : virtucamera.VCServer object
    Instance of virtucamera.VCServer calling this method.
start : float
    Animation range start frame number.
end : float
    Animation range end frame number.

start_playback( vcserver, forward )

This method must start the playback of animation in the scene.
Not used at the moment, but must be implemented just in case
the app starts using it in the future. At the moment
VCBase.set_frame() is called instead.

Parameters
----------
vcserver : virtucamera.VCServer object
    Instance of virtucamera.VCServer calling this method.
forward : bool
    if True, play the animation forward, if False, play it backwards.

stop_playback( vcserver )

This method must stop the playback of animation in the scene.
Not used at the moment, but must be implemented just in case
the app starts using it in the future.

Parameters
----------
vcserver : virtucamera.VCServer object
    Instance of virtucamera.VCServer calling this method.