The ClipMediaBase type exposes the following members.

Constructors

  NameDescription
ClipMediaBase
Initializes a new instance of the ClipMediaBase class.

Methods

  NameDescription
Dispose
Releases unmanaged and - optionally - managed resources
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
InitialiseShow
Intialises the clip ready for playback.
Load
Loads the clip so it is ready to use.
LoadMedia
Loads a clip and handles the nesasery events during the load operation.
LoadSettings
Loads the settings for this clip from an xml file.
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnFinished Obsolete.
Raises the Finished event.
OnInitialiseShow
OnLoadClip
This function should be overriden to perform operations to load your clip after it is first created.
OnLoadSettings
Override to load any custom settings for this clip.
OnSaveSettings
Override to save any custom settings for this clip.
OnUnhandledException
Logs the clip exception with the Screen Monkey error reporting system.
RaiseFinished
Raises the Finished event.
RaiseShowInitialised
Raises the ShowInitialising event.
RaiseShowInitialising
Raises the ShowInitialising event.
Remove
This function is called when a clip is remved from Screen Monkey and performs any cleaning up of the clip.
RepairOverloaded.
SaveSettings
Saves the settings for this clip to an xml file.
StartShow
Starts the show and begins playback of the clip.
StartShowLive
This is called when the show has been started and the screen is live. This is different to StartShow in that it is called after the screen has been displayed and is visible on the screen. You can override this function to perform operations which are nesasery whilst the clip is visible on the screen.
StopShow
Stops the show running and frees up any resources from playback.
ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Fields

  NameDescription
loadMediaThread
This is the thread used to load the clip.
mediaLoadedManualEvent
This event is set when the loading has completed.

Properties

  NameDescription
Active
Gets or sets whether this clip is being displayed.
Caption
Gets the caption to be displayed to the user to describe the clip
CleanupTempFolder
Gets whether to delete the clips temporary folder when the software shuts down.
ClipTempFolder
Gets a folder path where this clip can store files and information.
Description
Gets the description of what the clip does.
EffectsSupported
Gets whether clip transition effects should be used with this clip.
FinishSupported
Gets whether this clip has a finishing point.
Hotkey
Gets or sets a keyboard key which when pressed will play this clip.
Id
Gets or sets a unique Id used to identify the clip.
Index
This is the handle index used to determine what order to place clips in when showing to the user.
Initialising
Gets whether this clip is being initialised ready to start playing.
Live
Gets or sets whether this clip is the current clip being displayed.
LiveMonitor
Gets a control which shows a live monitor of the main clip output. When the clip is live this will be shown in the layer monitor window.
LoadStatus
Gets the curent loading status of the clip.
MainOutput
Gets a GDI control which displays this clips output. This is used by the standard renderer to display the clip on the screen.
MediaFile
Gets or sets the media file which this clip is created from.
NeedsRepairing
Gets whether this clip needs to be repaired or not.
RootFolder
Gets the root folder where all clips store any data they require.
ThumbnailGenerationEnabled
Gets or sets whether a clip should generate its own thumbnails from the media or use the default clip logo.
ThumbnailImage
Gets or sets a thumbnail image representation of the clip.
TypeName
Gets the name for the clip type e.g. Colour, Video

Events

  NameDescription
ActiveChanged
Ocurrs when this clip changes its Active state.
Finished
Ocurrs when the clip is still running but the media has reached the end.
LiveChanged
Ocurrs when this clip changes its Live state.
MediaLoaded
Ocurrs when the clip finishes loading.
ShowInitialised
Ocurrs when the show has completed initialising.
ShowInitialising
Ocurrs when the show is intialising and InitialiseShow()()() has been called.
ShowStarted
Ocurrs when the show sarts and the clip has begun playing.
ShowStopped
Ocurrs when the slip has stopped playing.
ThumbnailChanged
Ocurrs when the thumbnail image representing this clip changes.
UnhandledException
Ocurrs when an exception has ocurred in this clip that should be logged.

See Also