PTMovie

@interface PTMovie : PTAnnot

A movie annotation contains animated graphics and sound to be presented on the computer screen and through the speakers. When the annotation is activated, the movie is played.

  • Creates a Movie annotation and initializes it using given Cos/SDF object.

    Note

    The constructor does not copy any data, but is instead the logical equivalent of a type cast.

    Declaration

    Objective-C

    - (instancetype)initWithD:(PTObj *)d;

    Swift

    init!(d: PTObj!)

    Parameters

    d

    The Cos/SDF object to initialze the annotation with.

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithAnn: (PTAnnot*)ann;

    Swift

    init!(ann: PTAnnot!)

  • Creates a new Movie annotation in the specified document.

    Declaration

    Objective-C

    + (PTMovie *)Create:(PTSDFDoc *)doc pos:(PTPDFRect *)pos;

    Swift

    class func create(_ doc: PTSDFDoc!, pos: PTPDFRect!) -> PTMovie!

    Parameters

    doc

    A document to which the Movie annotation is added.
    pos

    A rectangle specifying the Movie annotation’s bounds in default user space units.

    Return Value

    A newly created blank Movie annotation.

  • Undocumented

    Declaration

    Objective-C

    + (PTMovie*)CreateAnnot: (PTSDFDoc*)doc pos:  (PTPDFRect*)pos;

    Swift

    class func createAnnot(_ doc: PTSDFDoc!, pos: PTPDFRect!) -> PTMovie!

  • Returns the title of the Movie Annotation.

    Note

    Movie actions may use this title to reference the movie annotation.

    Declaration

    Objective-C

    - (NSString *)GetTitle;

    Swift

    func getTitle() -> String!

    Return Value

    A string representing the title of the Movie Annotation.

  • Sets the title of the Movie Annotation. (Optional)

    Note

    Movie actions may use this title to reference the movie annotation.

    Declaration

    Objective-C

    - (void)SetTitle:(NSString *)title;

    Swift

    func setTitle(_ title: String!)

    Parameters

    title

    A string representing the title of the Movie Annotation.

  • Returns the option of whether the Movie is to be played.

    Note

    IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.

    Declaration

    Objective-C

    - (BOOL)IsToBePlayed;

    Swift

    func isToBePlayed() -> Bool

    Return Value

    a boolean value indicating if the movie is to be played.

  • Sets the option of whether the Movie is to be played. (Optional)

    Note

    IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.

    Declaration

    Objective-C

    - (void)SetToBePlayed:(BOOL)isplay;

    Swift

    func setToBePlayed(_ isplay: Bool)

    Parameters

    isplay

    A boolean value telling if the movie is to be played. Default value: true.