Skip to content

Commit

Permalink
Fix the documentation. Correct option is iframe, not frame
Browse files Browse the repository at this point in the history
  • Loading branch information
filhit committed Apr 24, 2016
1 parent 89d6106 commit 51d76e6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Filename: FooplayerController.js

- `buttonSwitch` - Used to determine playing state. Set to `true` if a site only shows the pause button when it's playing and only shows the play button when it's paused.
- `playState` - Used to determine playing state. Set to the selector that will return `true` iff the player is playing. Example: `playState: "#play_btn.playing"`
- `frame` - Used when the player is nested inside an iframe. Set to the selector of the iframe containing the player. Example: `frame: "#player-frame"`
- `iframe` - Used when the player is nested inside an iframe. Set to the selector of the iframe containing the player. Example: `iframe: "#player-frame"`

**Note**: One of `buttonSwitch` or `playState` should (almost) always be set. If `buttonSwitch` is true then your controller **must** define both `play` and `pause` selectors. If a `playState` is defined, then you controller might have either a single `playPause` selector or both `play` and `pause` selectors.

Expand Down

0 comments on commit 51d76e6

Please sign in to comment.