NAME
Video::CPL::Cue - Create a Cue object.
VERSION
Version 0.10
SYNOPSIS
use Video::CPL::Cue;
my $foo = Video::CPL::Cue->new(cueType=>"regular",name=>"fooba",time=23.7,interestURL="http://foo.com");SUBROUTINES/METHODS
name([$name])
Accessor function to get or set name.cueType([$type])
Accessor function to get or set cueType.time([$time])
Accessor function to get or set time.tags([$tags])
Accessor function to get or set tags.interestURL([$url])
Accessor function to get or set interestURL.query([$query])
Accessor function to get or set query.zeroLen([$tf])
Accessor function to get or set zeroLen.cannotSkip([$tf])
Accessor function to get or set cannotSkip.pauseOnEntry([$tf])
Accessor function to get or set pauseOnEntry.modalOnEntry([$tf])
Accessor function to get or set modalOnEntry.soft([$tf])
Accessor function to get or set soft.js([$javascript])
Accessor function to get or set js, the Javascript to be used when this cuePoint is reached.backgroundHTML([$url])
Accessor function to get or set backgroundHTML.coincidentWebPoint([$value])
Accessor function to get or set coincidentWebPointpauseOnDisplay([$tf])
Accessor function to get or set pauseOnDisplay.mxmlInCPL([$mxmlcode])
Accessor function to get or set mxmlInCPL.videoBottom([$value])
Accessor function to get or set videoBottom.useLayout([$layoutname])
Accessor function to get or set useLayout.webViewLayout([$webViewLayout])
Accessor function to get or set webViewLayout.videoHCenter([$value])
Accessor function to get or set videoHCenter.webBottom([$value])
Accessor function to get or set webBottom.annotationList([$annotationlist])
Accessor function to get or set annotationList.directoryList([$directorylist])
Accessor function to get or set directoryList.targetList([$targetList])
Accessor function to get or set targetList.story([$story])
Accessor function to get or set story.parent([$videoCPLobject])
Accessor function to get or set parent. Video::CPL::Cue tracks the parent Video::CPL object, so as to be
able to generate an appropriate reference for external CPL files.new([name=>$name,cueType=>$type,time=>$val,tags=>$string,interestURL=>$url,query=>string, zeroLen=>$tf,cannotSkip=>$tf,pauseOnEntry=>$tf,modalOnEntry=>$tf,soft=>$tf,js=>$javascript, backgroundHTML=>$url,coincidentWebPoint=>$val,pauseOnDisplay=>$tf,canBeDestination=>$tf, mxmlInCPL=>$mxml,videoBottom=>$value,useLayout=>$layout,webViewLayout=>$layout, videoHCenter=>$value,webBottom=>$value]);
Return a new Cue object, with the parameters set as specified. An advantage of using the
CPL::Video helper functions instead is that parent will be automatically set. Rather than:
$cue = new Video::CPL::Cue(name=>"foo",time=>3,cueType=>regular);
$cpl->addcue($cue);
use:
$cpl->regular(time=>3,name=>"foo");
Names will be automatically created if not specified, so an even shorter version would be:
$cpl->regular(time=>3);adjust([name=>$name,cueType=>$type,time=>$val,tags=>$string,interestURL=>$url,query=>string, zeroLen=>$tf,cannotSkip=>$tf,pauseOnEntry=>$tf,modalOnEntry=>$tf,soft=>$tf,js=>$javascript, backgroundHTML=>$url,coincidentWebPoint=>$val,pauseOnDisplay=>$tf,canBeDestination=>$tf, mxmlInCPL=>$mxml,videoBottom=>$value,useLayout=>$layout,webViewLayout=>$layout, videoHCenter=>$value,webBottom=>$value]);
Change arbitrary fields within a Cue point.fromxml()
setdl()
addanno()
annotations()
setstory()
dostandard()
dostandard is an internal utility routine for adding a cuepoint regular()
returnend()
programend()
choice()
goto()
decoration(%parms)
Add a new clickBehavior=decoration annotation to the parent of this Video::CPL::Cue, and add a cuePointRef to it from this object. Parameters are the same as for CPL::Annotation::new except that clickBehavior=decoration is implied. An javascript(%parms)
Add a new clickBehavior=javascript annotation to this Video::CPL::Cue. Parameters are the same as for CPL::Annotation::new except that clickBehavior=javascript is implied.returnEnd(%parms)
Add a new clickBehavior=returnEnd annotation to this Video::CPL::Cue. Parameters are the same as for Video::CPL::Annotation::new except that clickBehavior=returnEnd is implied. xml()
Return the text form of a Cue object.reffromobj($cplobj)
return the string needed to refer to this in the context of a particular CPL object.printref()
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::CueLICENSE 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.0Unless 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.