Trees       Indices       Help   
VRED Python API v1
Module vrMoviePlayer2 :: Class vrMoviePlayer2
[frames] | no frames]

Class vrMoviePlayer2

   object --+        
            |        
  ??.instance --+    
                |    
vrAEBase.vrAEBase --+
                    |
                   vrMoviePlayer2

Maps a movie on a node.

Instance Methods
 
__init__(node1, node2, filename, yuv)
The constructor of the vrMoviePlayer2 class.
 
disableChromaKeying()
Disables Chroma keying on the movie.
 
disableFillColor()
Disables the fill color and only blends alpha channel.
 
disableLuminanceKeying()
Disables Luminance keying on the movie.
 
disableSaturationKeying()
Disables Saturation keying on the movie.
 
enableChromaKeying(value, blendStart, blendEnd)
Enables Chroma keying on the movie.
 
enableFillColor(red, green, blue, alpha)
Sets the fill color for keying on the movie.
 
enableLuminanceKeying(value, blendStart, blendEnd)
Enables Luminance keying on the movie.
 
enableSaturationKeying(value, blendStart, blendEnd)
Enables Saturation keying on the movie.
int (32bit)
getDroppedFrames()
Returns the number of dropped frames.
double
getDuration()
Returns the movie duration.
int (64bit)
getFrameCount()
Gets the frame count.
int (64bit)
getFrameNumber()
Returns the current frame number.
double
getPlaybackSpeed()
Returns playback speed of the movie.
double
getPosition()
Returns the movie position.
 
setFrameNumber(fn)
Sets the current frame number.
 
setLoop(state)
Sets repeat mode.
 
setOpacity(opacity)
Sets the opacity of the movie.
 
setPausedFrameNumber(fn)
Sets the current frame number and pauses the movie.
 
setPlay(state)
Toggles between play and pause.
 
setPlaybackSpeed(r)
Sets the playback speed of the movie.
 
setPosition(t)
Set movie position.
 
setTransform(x, y, xscale, yscale)
Transforms the movie.

Inherited from vrAEBase.vrAEBase: __reduce__, addLoop, callAllConnected, connect, connectSignal, emitSignal, getModuleName, isActive, loop, recEvent, removeConnections, setActive, setUpdateGUIEnabled, subLoop

Inherited from unreachable.instance: __new__

Class Variables
  __instance_size__ = 456
Method Details

__init__(node1, node2, filename, yuv)
(Constructor)

 

The constructor of the vrMoviePlayer2 class.

Parameters:
  • node1 (vrNodePtr) - The node to map the movie to.
  • node2 (vrNodePtr) - The second node to map the second (right) stereo channel to (Optional).
  • filename (string) - The name of the movie file.
  • yuv (bool) - True for YUV video, false otherwise (Optional). Default is false.
Overrides: vrAEBase.vrAEBase.__init__

enableChromaKeying(value, blendStart, blendEnd)

 

Enables Chroma keying on the movie.

Parameters:
  • value (float) - The keying hue value in the range 0 to 360.
  • blendStart (float) - The start offset for the beginning of the edge blending in the range 0 to 1.
  • blendEnd (float) - The end offset for the end of the edge blending in the range 0 to 1.

enableFillColor(red, green, blue, alpha)

 

Sets the fill color for keying on the movie.

Parameters:
  • red (float) - The red component in the range 0 to 1.
  • green (float) - The green component in the range 0 to 1.
  • blue (float) - The blue component in the range 0 to 1.
  • alpha (float) - The alpha component in the range 0 to 1.

enableLuminanceKeying(value, blendStart, blendEnd)

 

Enables Luminance keying on the movie.

Parameters:
  • value (float) - The keying luminance value in the range 0 to 1.
  • blendStart (float) - The start offset for the beginning of the edge blending in the range 0 to 1.
  • blendEnd (float) - The end offset for the end of the edge blending in the range 0 to 1.

enableSaturationKeying(value, blendStart, blendEnd)

 

Enables Saturation keying on the movie.

Parameters:
  • value (float) - The keying saturation value in the range 0 to 1.
  • blendStart (float) - The start offset for the beginning of the edge blending in the range 0 to 1.
  • blendEnd (float) - The end offset for the end of the edge blending in the range 0 to 1.

getDroppedFrames()

 

Returns the number of dropped frames.

Returns: int (32bit)
The number of dropped frames.

getDuration()

 

Returns the movie duration.

Returns: double
The time in seconds.

getFrameCount()

 

Gets the frame count.

Returns: int (64bit)
The frame count.

getFrameNumber()

 

Returns the current frame number.

Returns: int (64bit)
The frame number.

getPlaybackSpeed()

 

Returns playback speed of the movie.

Returns: double
The speed factor (1.0 is the original speed).

getPosition()

 

Returns the movie position.

Returns: double
The time in seconds.

setFrameNumber(fn)

 

Sets the current frame number.

Parameters:
  • fn (int (64bit)) - The frame number.

setLoop(state)

 

Sets repeat mode.

Parameters:
  • state (bool) - Repeat mode: Enable/Disable.

setOpacity(opacity)

 

Sets the opacity of the movie.

Parameters:
  • opacity (float) - The opacity in the range 0 (fully transparent) to 1 (fully opaque).

setPausedFrameNumber(fn)

 

Sets the current frame number and pauses the movie.

Parameters:
  • fn (int (64bit)) - The frame number.

setPlay(state)

 

Toggles between play and pause.

Parameters:
  • state (bool) - Play/Pause movie.

setPlaybackSpeed(r)

 

Sets the playback speed of the movie.

Parameters:
  • r (double) - The speed factor (1.0 is the original speed).

setPosition(t)

 

Set movie position.

Parameters:
  • t (double) - The time in seconds.

setTransform(x, y, xscale, yscale)

 

Transforms the movie.

Parameters:
  • x (float) - The position on the x-axis.
  • y (float) - The position on the y-axis.
  • xscale (float) - The scale factor on the x-axis.
  • yscale (float) - The scale factor on the y-axis.

   Trees       Indices       Help   
VRED Python API v1
Generated by Epydoc 3.0.1 on Fri Nov 29 09:33:22 2024 http://epydoc.sourceforge.net