This class represents a clip (used to arrange readers on the timeline) More...

#include <Clip.h>

Inheritance diagram for openshot::Clip:

Public Member Functions
void	AddEffect (EffectBase *effect)
	Add an effect to the clip. More...

	Clip ()
	Default Constructor. More...

	Clip (string path)
	Constructor with filepath (reader is automatically created... by guessing file extensions) More...

	Clip (ReaderBase *new_reader)
	Constructor with reader. More...

void	Close () throw (ReaderClosed)
	Close the internal reader. More...

list< EffectBase * >	Effects ()
	Return the list of effects on the timeline. More...

float	End () throw (ReaderClosed)
	Override End() method. More...

void	End (float value)
	Set end position (in seconds) of clip (trim end of video) More...

tr1::shared_ptr< Frame >	GetFrame (long int requested_frame) throw (ReaderClosed)
	Get an openshot::Frame object for a specific frame number of this timeline. More...

string	Json ()
	Get and Set JSON methods. More...

Json::Value	JsonValue ()
	Generate Json::JsonValue for this object. More...

void	Open () throw (InvalidFile, ReaderClosed)
	Open the internal reader. More...

string	PropertiesJSON (long int requested_frame)

void	Reader (ReaderBase *new_reader)
	Set the current reader. More...

ReaderBase *	Reader () throw (ReaderClosed)
	Get the current reader. More...

void	RemoveEffect (EffectBase *effect)
	Remove an effect from the clip. More...

void	SetJson (string value) throw (InvalidJSON)
	Load JSON string into this object. More...

void	SetJsonValue (Json::Value root)
	Load Json::JsonValue into this object. More...

bool	Waveform ()
	Waveform property. More...

void	Waveform (bool value)
	Set the waveform property of this clip. More...

	~Clip ()
	Destructor. More...

Public Member Functions inherited from openshot::ClipBase
float	Duration ()
	Get the length of this clip (in seconds) More...

float	End ()
	Get end position (in seconds) of clip (trim end of video) More...

void	End (float value)
	Set end position (in seconds) of clip (trim end of video) More...

string	Id ()
	Get basic properties. More...

void	Id (string value)
	Set basic properties. More...

int	Layer ()
	Get layer of clip on timeline (lower number is covered by higher numbers) More...

void	Layer (int value)
	Set layer of clip on timeline (lower number is covered by higher numbers) More...

bool	operator< (ClipBase &a)

bool	operator<= (ClipBase &a)

bool	operator> (ClipBase &a)

bool	operator>= (ClipBase &a)

float	Position ()
	Get position on timeline (in seconds) More...

void	Position (float value)
	Set the Id of this clip object More...

float	Start ()
	Get start position (in seconds) of clip (trim start of video) More...

void	Start (float value)
	Set start position (in seconds) of clip (trim start of video) More...

Public Attributes
Keyframe	alpha
	Curve representing the alpha (1 to 0) More...

AnchorType	anchor
	The anchor determines what parent a clip should snap to. More...

GravityType	crop_gravity
	Cropping needs to have a gravity to determine what side we are cropping. More...

Keyframe	crop_height
	Curve representing height in percent (0.0=0%, 1.0=100%) More...

Keyframe	crop_width
	Curve representing width in percent (0.0=0%, 1.0=100%) More...

Keyframe	crop_x
	Curve representing X offset in percent (-1.0=-100%, 0.0=0%, 1.0=100%) More...

Keyframe	crop_y
	Curve representing Y offset in percent (-1.0=-100%, 0.0=0%, 1.0=100%) More...

GravityType	gravity
	The gravity of a clip determines where it snaps to it's parent. More...

Keyframe	location_x
	Curve representing the relative X position in percent based on the gravity (-100 to 100) More...

Keyframe	location_y
	Curve representing the relative Y position in percent based on the gravity (-100 to 100) More...

Keyframe	perspective_c1_x
	Curves representing X for coordinate 1. More...

Keyframe	perspective_c1_y
	Curves representing Y for coordinate 1. More...

Keyframe	perspective_c2_x
	Curves representing X for coordinate 2. More...

Keyframe	perspective_c2_y
	Curves representing Y for coordinate 2. More...

Keyframe	perspective_c3_x
	Curves representing X for coordinate 3. More...

Keyframe	perspective_c3_y
	Curves representing Y for coordinate 3. More...

Keyframe	perspective_c4_x
	Curves representing X for coordinate 4. More...

Keyframe	perspective_c4_y
	Curves representing Y for coordinate 4. More...

Keyframe	rotation
	Curve representing the rotation (0 to 360) More...

ScaleType	scale
	The scale determines how a clip should be resized to fit it's parent. More...

Keyframe	scale_x
	Curve representing the horizontal scaling in percent (0 to 100) More...

Keyframe	scale_y
	Curve representing the vertical scaling in percent (0 to 100) More...

Keyframe	shear_x
	Curve representing X shear angle in degrees (-45.0=left, 45.0=right) More...

Keyframe	shear_y
	Curve representing Y shear angle in degrees (-45.0=down, 45.0=up) More...

Keyframe	time
	Curve representing the frames over time to play (used for speed and direction of video) More...

Keyframe	volume
	Curve representing the volume (0 to 1) More...

Color	wave_color
	Curve representing the color of the audio wave form. More...

Protected Attributes
CriticalSection	getFrameCriticalSection
	Section lock for multiple threads. More...

Protected Attributes inherited from openshot::ClipBase
float	end
	The position in seconds to end playing (used to trim the ending of a clip) More...

string	id
	ID Property for all derived Clip and Effect classes. More...

int	layer
	The layer this clip is on. Lower clips are covered up by higher clips. More...

float	position
	The position on the timeline where this clip should start playing. More...

string	previous_properties
	This string contains the previous JSON properties. More...

float	start
	The position in seconds to start playing (used to trim the beginning of a clip) More...

Additional Inherited Members
Protected Member Functions inherited from openshot::ClipBase
Json::Value	add_property_choice_json (string name, int value, int selected_value)
	Generate JSON choice for a property (dropdown properties) More...

Json::Value	add_property_json (string name, float value, string type, string memo, bool contains_point, int number_of_points, float min_value, float max_value, InterpolationType intepolation, int closest_point_x, bool readonly)
	Generate JSON for a property. More...

Detailed Description

This class represents a clip (used to arrange readers on the timeline)

Each image, video, or audio file is represented on a layer as a clip. A clip has many properties that affect how it behaves on the timeline, such as its size, position, transparency, rotation, speed, volume, etc...

// Create some clips
Clip c1(new ImageReader("MyAwesomeLogo.jpeg"));
Clip c2(new FFmpegReader("BackgroundVideo.webm"));
// CLIP 1 (logo) - Set some clip properties (with Keyframes)
c1.Position(0.0); // Set the position or location (in seconds) on the timeline
c1.gravity = GRAVITY_LEFT; // Set the alignment / gravity of the clip (position on the screen)
c1.scale = SCALE_CROP; // Set the scale mode (how the image is resized to fill the screen)
c1.Layer(1); // Set the layer of the timeline (higher layers cover up images of lower layers)
c1.Start(0.0); // Set the starting position of the video (trim the left side of the video)
c1.End(16.0); // Set the ending position of the video (trim the right side of the video)
c1.alpha.AddPoint(1, 0.0); // Set the alpha to transparent on frame #1
c1.alpha.AddPoint(500, 0.0); // Keep the alpha transparent until frame #500
c1.alpha.AddPoint(565, 1.0); // Animate the alpha from transparent to visible (between frame #501 and #565)
// CLIP 2 (background video) - Set some clip properties (with Keyframes)
c2.Position(0.0); // Set the position or location (in seconds) on the timeline
c2.Start(10.0); // Set the starting position of the video (trim the left side of the video)
c2.Layer(0); // Set the layer of the timeline (higher layers cover up images of lower layers)
c2.alpha.AddPoint(1, 1.0); // Set the alpha to visible on frame #1
c2.alpha.AddPoint(150, 0.0); // Animate the alpha to transparent (between frame 2 and frame #150)
c2.alpha.AddPoint(360, 0.0, LINEAR); // Keep the alpha transparent until frame #360
c2.alpha.AddPoint(384, 1.0); // Animate the alpha to visible (between frame #360 and frame #384)

Definition at line 108 of file Clip.h.

Constructor & Destructor Documentation

Clip::Clip ( )

Default Constructor.

Definition at line 92 of file Clip.cpp.

Clip::Clip ( string path )

Constructor with filepath (reader is automatically created... by guessing file extensions)

Parameters

path	The path of a reader (video file, image file, etc...). The correct reader will be used automatically.

Definition at line 116 of file Clip.cpp.

Clip::Clip ( ReaderBase * new_reader )

Constructor with reader.

Parameters

new_reader The reader to be used by this clip

Definition at line 99 of file Clip.cpp.

Clip::~Clip ( )

Destructor.

Definition at line 163 of file Clip.cpp.

Member Function Documentation

void Clip::AddEffect ( EffectBase * effect )

Add an effect to the clip.

Parameters

effect Add an effect to the clip. An effect can modify the audio or video of an openshot::Frame.

Definition at line 916 of file Clip.cpp.

void Clip::Close	(		)
throw	(	ReaderClosed
	)

Close the internal reader.

Definition at line 213 of file Clip.cpp.

list<EffectBase*> openshot::Clip::Effects ( )

inline

Return the list of effects on the timeline.

Definition at line 176 of file Clip.h.

float Clip::End	(		)
throw	(	ReaderClosed
	)

Override End() method.

Get end position (in seconds) of clip (trim end of video), which can be affected by the time curve.

Definition at line 225 of file Clip.cpp.

void openshot::Clip::End ( float value )

inline

Set end position (in seconds) of clip (trim end of video)

Definition at line 196 of file Clip.h.

tr1::shared_ptr< Frame > Clip::GetFrame	(	long int	requested_frame	)
throw	(	ReaderClosed
	)

Get an openshot::Frame object for a specific frame number of this timeline.

Returns: The requested frame (containing the image)

Parameters

requested_frame The frame number that is requested

Definition at line 247 of file Clip.cpp.

string Clip::Json ( )

virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::ClipBase.

Definition at line 588 of file Clip.cpp.

Json::Value Clip::JsonValue ( )

virtual

Generate Json::JsonValue for this object.

Implements openshot::ClipBase.

Definition at line 659 of file Clip.cpp.

void Clip::Open	(		)
throw	(	InvalidFile,
		ReaderClosed
	)

Open the internal reader.

Definition at line 196 of file Clip.cpp.

string Clip::PropertiesJSON ( long int requested_frame )

virtual

Get all properties for a specific frame (perfect for a UI to display the current state of all properties at any time)

Implements openshot::ClipBase.

Definition at line 595 of file Clip.cpp.

void Clip::Reader ( ReaderBase * new_reader )

Set the current reader.

Parameters

new_reader The reader to be used by this clip

Definition at line 179 of file Clip.cpp.

ReaderBase * Clip::Reader	(		)
throw	(	ReaderClosed
	)

Get the current reader.

Definition at line 186 of file Clip.cpp.

void Clip::RemoveEffect ( EffectBase * effect )

Remove an effect from the clip.

Parameters

effect Remove an effect from the clip.

Definition at line 926 of file Clip.cpp.

void Clip::SetJson	(	string	value	)
throw	(	InvalidJSON
	)

virtual

Load JSON string into this object.

Implements openshot::ClipBase.

Definition at line 711 of file Clip.cpp.

void Clip::SetJsonValue ( Json::Value root )

virtual

Load Json::JsonValue into this object.

Implements openshot::ClipBase.

Definition at line 734 of file Clip.cpp.

bool openshot::Clip::Waveform ( )

inline

Waveform property.

Get the waveform property of this clip

Definition at line 213 of file Clip.h.

void openshot::Clip::Waveform ( bool value )

inline

Set the waveform property of this clip.

Definition at line 214 of file Clip.h.

Member Data Documentation

Keyframe openshot::Clip::alpha

Curve representing the alpha (1 to 0)

Definition at line 223 of file Clip.h.

AnchorType openshot::Clip::anchor

The anchor determines what parent a clip should snap to.

Definition at line 152 of file Clip.h.

GravityType openshot::Clip::crop_gravity

Cropping needs to have a gravity to determine what side we are cropping.

Definition at line 234 of file Clip.h.

Keyframe openshot::Clip::crop_height

Curve representing height in percent (0.0=0%, 1.0=100%)

Definition at line 236 of file Clip.h.

Keyframe openshot::Clip::crop_width

Curve representing width in percent (0.0=0%, 1.0=100%)

Definition at line 235 of file Clip.h.

Keyframe openshot::Clip::crop_x

Curve representing X offset in percent (-1.0=-100%, 0.0=0%, 1.0=100%)

Definition at line 237 of file Clip.h.

Keyframe openshot::Clip::crop_y

Curve representing Y offset in percent (-1.0=-100%, 0.0=0%, 1.0=100%)

Definition at line 238 of file Clip.h.

CriticalSection openshot::Clip::getFrameCriticalSection

protected

Section lock for multiple threads.

Definition at line 111 of file Clip.h.

GravityType openshot::Clip::gravity

The gravity of a clip determines where it snaps to it's parent.

Definition at line 150 of file Clip.h.

Keyframe openshot::Clip::location_x

Curve representing the relative X position in percent based on the gravity (-100 to 100)

Definition at line 219 of file Clip.h.

Keyframe openshot::Clip::location_y

Curve representing the relative Y position in percent based on the gravity (-100 to 100)

Definition at line 220 of file Clip.h.

Keyframe openshot::Clip::perspective_c1_x

Curves representing X for coordinate 1.

Definition at line 243 of file Clip.h.

Keyframe openshot::Clip::perspective_c1_y

Curves representing Y for coordinate 1.

Definition at line 244 of file Clip.h.

Keyframe openshot::Clip::perspective_c2_x

Curves representing X for coordinate 2.

Definition at line 245 of file Clip.h.

Keyframe openshot::Clip::perspective_c2_y

Curves representing Y for coordinate 2.

Definition at line 246 of file Clip.h.

Keyframe openshot::Clip::perspective_c3_x

Curves representing X for coordinate 3.

Definition at line 247 of file Clip.h.

Keyframe openshot::Clip::perspective_c3_y

Curves representing Y for coordinate 3.

Definition at line 248 of file Clip.h.

Keyframe openshot::Clip::perspective_c4_x

Curves representing X for coordinate 4.

Definition at line 249 of file Clip.h.

Keyframe openshot::Clip::perspective_c4_y

Curves representing Y for coordinate 4.

Definition at line 250 of file Clip.h.

Keyframe openshot::Clip::rotation

Curve representing the rotation (0 to 360)

Definition at line 224 of file Clip.h.

ScaleType openshot::Clip::scale

The scale determines how a clip should be resized to fit it's parent.

Definition at line 151 of file Clip.h.

Keyframe openshot::Clip::scale_x

Curve representing the horizontal scaling in percent (0 to 100)

Definition at line 217 of file Clip.h.

Keyframe openshot::Clip::scale_y

Curve representing the vertical scaling in percent (0 to 100)

Definition at line 218 of file Clip.h.

Keyframe openshot::Clip::shear_x

Curve representing X shear angle in degrees (-45.0=left, 45.0=right)

Definition at line 241 of file Clip.h.

Keyframe openshot::Clip::shear_y

Curve representing Y shear angle in degrees (-45.0=down, 45.0=up)

Definition at line 242 of file Clip.h.

Keyframe openshot::Clip::time

Curve representing the frames over time to play (used for speed and direction of video)

Definition at line 227 of file Clip.h.

Keyframe openshot::Clip::volume

Curve representing the volume (0 to 1)

Definition at line 228 of file Clip.h.

Color openshot::Clip::wave_color

Curve representing the color of the audio wave form.

Definition at line 231 of file Clip.h.

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation