Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #12

Merged
merged 4 commits into from
Feb 14, 2017
Merged

update readme #12

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b559aa8
known issue suggested fix
pussinboot Feb 10, 2017
ece8dc1
grammatical fixes
pussinboot Feb 10, 2017
4f157af
removed duplicate observations notes
pussinboot Feb 10, 2017
596a2f5
s/file/title
pussinboot Feb 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
s/file/title
  • Loading branch information
@pussinboot
pussinboot committed Feb 14, 2017
commit 596a2f53cf9300b61d4a38d410c31064498293b1
32 changes: 16 additions & 16 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ You can optionally pass a Json object with options to the constructor. Possible
* `debug` prints error messages
* `ipc_command` sets the ipc command to start the ipc socket. Possible options are **--input-unix-socket** and **--input-ipc-server**. This is usually not needed since **Node-MPV** is able to determine the correct command on its own
* `socket` specifies the socket **mpv** opens
* `time_update` the time interval in seconds, how often **mpv** should report the current time position, when playing a file
* `time_update` the time interval in seconds, how often **mpv** should report the current time position, when playing a song or video
* `verbose` will print various information on the console

You can also provide an optional second argument, an Array containing **mpv** command line options. A list of available arguments can be found in the [documentation](https://mpv.io/manual/stable/#options)
Expand Down Expand Up @@ -114,11 +114,11 @@ mpvPlayer.on('stopped', function() {

Will load the `file` and start playing it. This behaviour can be changed using the `mode` option

* `replace`*(default)* replace current file and play it immediately
* `replace`*(default)* replace current title and play it immediately
* `append` appends the file to the playlist
* `append-play` appends the file to the playlist. If the playlist is empty this file will be played

There is another `append` function in the **playlist** section, which can be used to append files and streams.
There is another `append` function in the **playlist** section, which can be used to append either files or streams.

* **loadStream** (url)

Expand Down Expand Up @@ -175,15 +175,15 @@ mpvPlayer.on('stopped', function() {

* **seek** (seconds)

Will jump back or forth in the song for the specified amount of `seconds`. Going beyond the duration of a file results in the playback stopping
Will jump back or forth in the song or video for the specified amount of `seconds`. Going beyond the duration of a title results in the playback stopping

* **goToPosition** (seconds)

Jumps to the position specified by `seconds`. Going beyond the boundaries of a file results in playback stopping
Jumps to the position specified by `seconds`. Going beyond the boundaries of a title results in playback stopping

* **loop** (times)

Loops the current file `times` often. If set to *"inf"* the file is looped forever
Loops the current title `times` often. If set to *"inf"* the title is looped forever

## Playlists

Expand All @@ -200,34 +200,34 @@ mpvPlayer.on('stopped', function() {

Appends `file` (which can also be an url) to the playlist.

* `append` *(default)* Append the file
* `append-play` When the playlist was empty the file will be started
* `append` *(default)* Append the title
* `append-play` When the playlist is empty the title will be started

* **next** (mode="weak")

Skips the current file. `mode` can be one of the following two
Skips the current title. `mode` can be one of the following two

* `weak` *(default*) If the file is the last file in the playlist it is not skipped
* `strong` The file is skipped and playback is stopped
* `weak` *(default*) If the current title is the last one in the playlist it is not skipped
* `strong` The title is skipped and playback is stopped

* **prev** (mode="weak")

Skips the current file. `mode` can be one of the following two
Skips the current title. `mode` can be one of the following two

* `weak` *(default*) If the file is the first song in the playlist it is not stopped
* `strong` The file is skipped and playback is stopped
* `weak` *(default*) If the title is the first one in the playlist it is not stopped
* `strong` The title is skipped and playback is stopped

* **clearPlaylist** ()

Clears the playlist

* **playlistRemove** (index)

Removes the file at `index` from the playlist. If `index` is set to "current" the current file is removed and playback stops
Removes the title at `index` from the playlist. If `index` is set to "current" the current title is removed and playback stops

* **playlistMove** (index1, index2)

Moves the file at `index1` to the position at `index2`
Moves the title at `index1` to the position at `index2`

* **shuffle** ()

Expand Down