doc/signals.txt
author veltr
Fri, 27 Apr 2012 19:18:21 +0200
branchnew-model
changeset 881 f11b234497f7
parent 812 c014ceb37645
permissions -rw-r--r--
Finished Mediafragment
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
812
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     1
This is the list of the signals sent by the different widgets :
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     2
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     3
Mediafragments
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     4
==============    
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     5
    IriSP.Mediafragment.hashchange(hashvalue): This message is used by the iframe embed code to relay data
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     6
    outside of the iframe. This message sends as a parameter the
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     7
    new anchor value of the url.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     8
            
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
     9
    IriSP.Mediafragment.showAnnotation(annotationId): This message is sent when the mediafragment code 
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    10
                                                      has fast-forwarded to the beginning of an annotation
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    11
                                                      specified in the url. The subscribing widgets receive
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    12
                                                      the id of the annotation and can highlight it if they
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    13
                                                      want.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    14
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    15
PlayerWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    16
============                                                      
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    17
    IriSP.PlayerWidget.AnnotateButton.clicked: sent whenever the "Annotate" button is clicked on the player widget.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    18
    IriSP.PlayerWidget.MouseOver: sent when the mouse is hovering the widget. Used to maximize the sliderWidget to 
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    19
                                  get a behaviour similar to youtube.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    20
    IriSP.PlayerWidget.MouseOut: sent when the mouse has left the widget.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    21
    
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    22
    IriSP.search.open: sent when the searchbox has been opened
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    23
    IriSP.search.closed: sent when the searchbox has been closed
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    24
    IriSP.search(searchQuery): sent whenever the user presses a key in the searchfield. Param searchQuery 
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    25
                               holds the contents of the search field. 
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    26
    
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    27
    IriSP.search.triggeredSearch(searchText): triggered by other widgets when they want to launch a new search. searchText is the search term. 
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    28
    IriSP.search.noMatchFound: triggered by other widgets to indicate that they've not found content matching the search terms.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    29
    IriSP.search.matchFound: triggered by other widgets to indicate that they've found content matching the search terms.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    30
    Note: the PlayerWidget changes the highlighting of the search box depending on if it has received these messages.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    31
    
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    32
ArrowWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    33
===========
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    34
    IriSP.ArrowWidget.blockArrow: prevent the ArrowWidget from moving automatically
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    35
    IriSP.ArrowWidget.releaseArrow: restore the ArrowWidget to its non-blocked state
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    36
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    37
SliceWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    38
===========
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    39
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    40
    IriSP.SliceWidget.hide: sent to the SliceWidget. hides the widget.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    41
    IriSP.SliceWidget.show: sent to the SliceWidget. shows the widget.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    42
    IriSP.SliceWidget.position, [left, width]: sent to the SliceWidget. Param is an array with the 
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    43
                                               left position and the width of the zone, in percents.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    44
    IriSP.SliceWidget.zoneChange [left, width]: sent by the widget whenever the user moves the widget. The parameter
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    45
                                                is an array with the left position of the zone its width. Both values
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    46
                                                are in percents.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    47
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    48
AnnotationWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    49
================                                               
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    50
    
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    51
    IriSP.AnnotationsWidget.show: received by the AnnotationsWidget. hides the widget.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    52
    IriSP.AnnotationsWidget.hide: received by the AnnotationsWidget. shows the widget.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    53
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    54
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    55
CreateAnnotationWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    56
======================
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    57
    
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    58
    IriSP.createAnnotationWidget.addedAnnotation(annotation): sent by the widget when an annotation has been created.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    59
                                                              passes the annotation dict as parameter.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    60
                                                              
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    61
PolemicWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    62
=============
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    63
    
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    64
    IriSP.PolemicTweet.click(elementId): sent by the widget when the user clicks on it. Passes the annotation id as a param.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    65
                                         the mediafragment modules listens to this message to update the url accordingly.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    66
                                         
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    67
SegmentsWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    68
==============
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    69
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    70
   IriSP.SegmentsWidget.click(annotationId): sent by the widget when the user clicks on it. Passes the annotation id as a param.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    71
                                         the mediafragment modules listens to this message to update the url accordingly.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    72
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    73
SparklineWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    74
===============
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    75
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    76
     IriSP.SparklineWidget.clicked(newTime): sent whenever the sparkline widget is clicked. Param newTime is the new time the video
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    77
                                             is seeking too. The mediafragment module listens to this.
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    78
                                             
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    79
StackGraphWidget
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    80
=================
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    81
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    82
     IriSP.StackGraphWidget.clicked(newTime): sent whenever the stackgraph widget is clicked. Param newTime is the new time the video
c014ceb37645 added some docs to document the signals sent by the player.
hamidouk
parents:
diff changeset
    83
                                             is seeking too. The mediafragment module listens to this.