All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.app.players.MoviePresenter

java.lang.Object
   |
   +----quicktime.app.image.ImagePresenter
           |
           +----quicktime.app.players.MoviePresenter

public class MoviePresenter

extends ImagePresenter

implements AudioSpec, Playable, DynamicImage, MovieDrawingComplete

Outside of the use in the SWCompositor this Presenter also gives the ability to apply a GraphicsMode to the overall output of a movie and can be used also for easy manipulation and control of a movie's display characteristics, location and transformations. For example if you are moving a movie around the screen (for example bouncing it around) you will get better performance of the visual output using a MoviePresenter than doing these kinds of activities with a standard MoviePlayer presentation.

In both cases it delegates its tasking requirements to the TaskAllMovies class and uses the MovieDrawingComplete callback to either invalidate its presenting TwoDSprite or to redraw itself to the destination QDGraphics.

See Also:

SWCompositor

spritePresenter

MoviePresenter(Movie)

Create a MoviePresenter with the supplied movie.

MoviePresenter(Movie, QDGraphics)

Create a MoviePresenter with the supplied movie.

addedToCompositor(SWCompositor, TwoDSprite)

Returns an object that invalidates a sprite.

execute(Movie)

Implements the execute method on the MovieDrawingComplete interface.

getDuration()

Returns the duration of the media attached to the player.

getMovie()

Return the movie that is being presented.

getOffscreenBuffer()

Returns the offscreen buffer that the movie of the MoviePresenter is drawing into.

getRate()

Returns the current rate of the Timeable object.

getScale()

Returns the time scale of the player - how many ticks per second.

getTime()

Returns the current time value of the object.

getTimeBase()

Returns the current time base that provides the time foundation of this object.

getVolume()

Returns the volume setting (0 is silent, 1 is unity gain).

isMuted()

Returns the current mute status.

isPresenting()

Returns true if the MoviePresenter is presenting its movie to a destination QDGraphics.

movieChanged()

If an application requires the MoviePresenter to explicitly invalidate its TwoDSprite Presenter, or redraw its offscreen image due to some change in the Movie (other than normal playback of the Movie) then it should signify this by calling this method.

redraw(Region)

QTCanvas calls this method when the client should redraw itself.

removedFromCompositor(SWCompositor)

When a dynamic image class is removed from a SWCompositor this method is called to allow the class to cleanup any of the invalidation processes it had established in the addedToCompositor call.

setGWorld(QDGraphics)

QTCanvas calls this method to give the client the QDGraphics object it should use to do its drawing.

setMuted(boolean)

Allows the muting of the specific channel.

setRate(float)

Sets the Timeable's playback rate.

setTime(int)

Sets the player to the time specified.

setVolume(float)

Sets the volume.

 protected TwoDSprite spritePresenter

 public MoviePresenter(Movie m) throws QTException

Create a MoviePresenter with the supplied movie. The movie will be rendered into a default offscreen QDGraphics and the pixel data of the QDGraphics buffer becomes the image data that this presenter presents.

Parameters:

m - the movie that is rendered

 public MoviePresenter(Movie m,
                       QDGraphics g) throws QTException

Create a MoviePresenter with the supplied movie. The movie will be rendered into the supplied offscreen QDGraphics and the pixel data of the QDGraphics buffer becomes the image data that this presenter presents.

Parameters:

m - the movie that is rendered

g - the offscreen QDGraphics that the effect is rendered into.

 public void setGWorld(QDGraphics cgp) throws QTException

QTCanvas calls this method to give the client the QDGraphics object it should use to do its drawing. If the incoming QDGraphics is the QDGraphics.scratch then the drawable will not be visible and can disable itself. If a client is unable to set the graphics world it should throw an exception.

Parameters:

cgp - a QDGraphics object

Overrides:

setGWorld in class ImagePresenter

 public boolean isPresenting()

Returns true if the MoviePresenter is presenting its movie to a destination QDGraphics.

Returns:

a boolean

 public int execute(Movie m)

Implements the execute method on the MovieDrawingComplete interface. This method will set the movie changed state to true, so that a consequent call to the TwoDSprite Invalidator will invalidate its presenting sprite. If the MoviePresenter is presenting a movie to a destination QDGraphics it will redraw the movie to that destination.

The callback will be triggered as a result of the tasking that is delegated to the TaskAllMovies object, and is fired whenever some change in the pixels as Movie draws to its internal QDGraphics - the offscreen buffer that the presenter presents.

Parameters:

m - the Movie that is presented by this presenter

Returns:

an error code or 0 if no error

 public Movie getMovie()

Return the movie that is being presented.

Returns:

a movie

 public QDGraphics getOffscreenBuffer()

Returns the offscreen buffer that the movie of the MoviePresenter is drawing into.

Returns:

a QDGraphics.

 public void redraw(Region invalidRgn) throws QTException

QTCanvas calls this method when the client should redraw itself. If the canvas is able to discern that only a part of the client's drawing area needs to be redrawn - then this area shall be passed in using the invalidRgn. Otherwise this will be null in which case the client should redraw itself entirely.

Parameters:

invalidRgn - the invalidRgn that the client should redraw

Overrides:

redraw in class ImagePresenter

 public TimeBase getTimeBase() throws QTException

Returns the current time base that provides the time foundation of this object.

Returns:

a TimeBase

 public void setRate(float rate) throws QTException

Sets the Timeable's playback rate. Typically a rate of zero will mean that the player is stopped, a positive value that the player is playing forwards, a negative value that the time values are decreasing.

Parameters:

rate - the new playback rate.

 public float getRate() throws QTException

Returns the current rate of the Timeable object.

Returns:

the playback rate

 public void setTime(int time) throws QTException

Sets the player to the time specified. This time value at this level is a totally arbitrary value - what time that means in "real time" is determined by the implementor of the interface, typically the scale value will determine what a "real" time of 1 second is.

Parameters:

time - the new time value

 public int getTime() throws QTException

Returns the current time value of the object.

Returns:

the current time.

 public int getDuration() throws QTException

Returns the duration of the media attached to the player. If the player has no media, or does not know the duration of its media it can return the constant kDurationUnknown.

Returns:

the media duration.

 public int getScale() throws QTException

Returns the time scale of the player - how many ticks per second.

Returns:

the current scale.

 public float getVolume() throws QTException

Returns the volume setting (0 is silent, 1 is unity gain).

Returns:

a float

 public void setVolume(float val) throws QTException

Sets the volume.

Parameters:

val - the new volume

 public boolean isMuted() throws QTException

Returns the current mute status.

Returns:

a boolean

 public void setMuted(boolean flag) throws QTException

Allows the muting of the specific channel. When unmuted the AudioSpec object will return to its current volume setting.

Parameters:

flag - turn muting on - true or off - false.

 public void movieChanged()

If an application requires the MoviePresenter to explicitly invalidate its TwoDSprite Presenter, or redraw its offscreen image due to some change in the Movie (other than normal playback of the Movie) then it should signify this by calling this method. Then in the normal course of Invalidation or Redrawing the MoviePresenter will do the correct thing. If the movie has a timeline and is playing this will be done automatically.

Thus a potential usage of this method is if the MoviePresenter is presenting a QuickTime VR movie that has no real time line, and has programatically changed some characteristic of the display of the Movie. In which case it needs to inform the MoviePresenter that the Movie has changed and it should do the appropriate invalidation or redraw.

 public Invalidator addedToCompositor(SWCompositor c,
                                      TwoDSprite s) throws QTException

Returns an object that invalidates a sprite. When a DynamicImage is a member of a SWompositor and the DynamicImage presents a changing image (for example a movie), the TwoDSprite that presents that image in the SWCompositor must be invalidated so that it will redraw the Sprites image in the next composit cycle. The Invalidator object is used to perform this function by the SWCompositor if the object itself cannot perform the invalidation. Can return null if the DynamicImage does not require the SWCompositor to invalidate it (or the object is in a state where its image won't change).

The Invalidators provided with objects that implement the DynamicImage interface will execute at the scale and period of the Compositor when they are created.

Parameters:

c - the Compositor in which the DynamicImage is a member

s - the TwoDSprite that is presenting the DynamicImage's image in the Compositor. This is the sprite that must be invalidated.

Returns:

an Invalidator or null if invalidation is not required

See Also:

SWCompositor

 public void removedFromCompositor(SWCompositor c) throws QTException

When a dynamic image class is removed from a SWCompositor this method is called to allow the class to cleanup any of the invalidation processes it had established in the addedToCompositor call.

Parameters:

c - the SWCompositor it is being removed from

All Packages  Class Hierarchy  This Package  Previous  Next  Index