NAME

Video::CPL::Annotation - Video::CPL::Annotation object.

VERSION

Version 0.10

SYNOPSIS

    Video::CPL::Annotate exists to create and manipulate Annotations. 

    use Video::CPL::Annotation;
    my $foo = Video::CPL::Annotation->new(name=>"alpha-tech",clickBehavior=>"goto",x=>772,y=>66,
                                          picLoc=>"foo.png");
    #for a single use, this could also be created by helper functions, with an auto-generated name:
    $cue->goto(x=>772,y=>66,picLoc=>"foo.png");

METHODS

name([$name])

    Accessor routine to get or set the name.

clickBehavior(["decoration|goto|returnEnd|javascript"])

    Accessor routine to get or set the clickBehavior. Other fields may need to be modified if this is changed.

x([$k])

    Accessor routine to get or set the x value of the Annotation.

y([$k])

    Accessor routine to get or set the y value of the Annotation.

skipOnReturn(["true|false"])

    Accessor routine to get or set skipOnReturn.

showIcon(["true|false]")

    Accessor routine to get or set showIcon.

ajs($javascriptcode)

    Accessor routine to get or set ajs, the javascript to be executed if clickBehavior is <b>javascript</b>.

story($story)

    Accessor routine to get or set the <b>story</b>.

picLoc([$urlorlocalref])

    Accessor routine to get or set the picLoc of an embedded <b>Story</b>. Will create the
    <b>Story</b> object if it does not exist and a parameter is given.

picOverLoc([$urlorlocalref])

    Accessor routine to get or set the picOverLoc of an embedded <b>Story</b>. Will create the
    <b>Story</b> object if it does not exist and a parameter is given.

alpha([$value])

    Accessor routine to get or set alpha.

targetList([$targetlist])

    Accessor routine to get or set targetList.

parent([$VideoCPLobject])

    Accessor routine to get or set the parent. Video::CPL::Annotation uses this field to determine the parent
    Video::CPL object.

new([name=>$name,clickBehavior=>$something,x=>$k,y=>$k,skipOnReturn=>$tf,showIcon=>$tf, story=>$story,ajs=>$javascript,alpha=>$value,targetList=>$targetList,target=>$cuepoint,parent=>$videocpl])

    Creates a new Annotation object. Will automatically create a name if not given, and 
    will convert a <b>Cue</b> passed as <b>target</b> to a <b>targetList</b>.

adjust([name=>$name,clickBehavior=>$what,skipOnReturn=>$tf,showIcon=>$tf,alpha=>$value, skipOnReturn=>$tf,x=>$x,y=>$y,story=>$story])

    Change arbitrary fields within an Annotation point.

fromxml()

xmlo()

    Return the text form of the Annotation. Usually called by Video::CPL::xml().

xml()

    Return the xml format of an Annotation object. Intended for special cases; normally the Video::CPL 
    method <b>xml</b> is called to obtain XML for the entire Video::CPL object at once.

reffromobj($cplobj)

    Returns the string used to refer to this Annotation from the Video::CPL object given.

printref()

    Return a cuePointRef to this Annotation.

AUTHOR

Carl Rosenberg, <perl at coincident.tv>

BUGS

Please report any bugs or feature requests to Coincident TV.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Video::CPL::Annotation

LICENSE AND COPYRIGHT

Copyright 2010 Coincident TV

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

cpanm Video::CPL

perl -MCPAN -e shell
install Video::CPL