User:Minooz/OSD600/popcorn/doc

Documentation for tagthisperson plugin

Name

tagthisperson

Example

 
var p = Popcorn('#video')
  .tagthisperson( {
    start: 0, // seconds
    end: 10, // seconds
    person: 'Anna Sob',
    image: 'http://newshour.s3.amazonaws.com/RichardNSmith_thumbnail.jpg',
    href: 'http://annasob.wordpress.com',
    target: 'tagdiv'
  } )
  .tagthisperson( {
    start: 5, // seconds
    end: 15, // seconds
    person: 'Scott',
    target: 'tagdiv'
  } ) 
}, false );

Description

Adds people's names to an element on the page

Options parameter will need a start, end, target, image, href and person.

Start is the time that you want this plug-in to execute

End is the time that you want this plug-in to stop executing

Person is the name of the person who you want to tag

Image is the url to the image of the person - optional

href is the url to the webpage of the person - optional

Target is the id of the document element that the text needs to be

attached to, this target element must exist on the DOM

Syntax

 
var p = Popcorn('#video')
  .tagthisperson( {
    start:
    end: 
    person: 
    image: 
    href: 
    target: 
  } )
}, false );

Parameters

 
  start   - The time that you want this plug-in to execute
  end     - The time that you want this plug-in to stop executing
  person  - The name of the person who you want to tag
  image   - The url to the image of the person - optional
  href    - The url to the webpage of the person - optional
  target  - The id of the document element that the text needs to be - attached to, this target element must exist on the DOM