Rezzect/syncplay
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Et0h 2012-09-22 01:46:02 +02:00
parent d70936e95b
commit 915ed8b5b8
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -5,7 +5,7 @@ Solution to synchronize video playback across multiple instances of MPlayer and/
## What does it do
Syncplay synchronizes the position and play state of multiple media players so that the viewers can watch the same thing at the same time.
When one person pauses playback, the media player is paused for all users who are connected to the same server and are in the same 'room'.
When one person pauses playback, the media player is paused for all users who are connected to the same server and are in the same 'room' (viewing session).
When one person seeks, all players seek to the same position. When a new person joins (or someone reconnects) they will be syncronised with their fellow viewers.
## What does it not do
@ -40,28 +40,6 @@ On Windows simply running `syncplayClient.exe` opens a Syncplay command-line win
If you open a file with `syncplayClient.exe` then it will automatically open Syncplay and load the file through MPC-HC on Windows and MPlayer on Linux.
### Command-line switches
You can run `syncplayClient.exe` with the following command-line arguments to alter the settings:
`--no-gui` - Do not display graphical user interface (GUI)
`--host [address]` - Specify address of server to connect to (can be address:port)
`--name [name]` / `-n [name]` - Specify username to use
`--debug` / `-d` - Enable debug mode
`--force-gui-prompt` / `-g` - Force the configuration window to appear when Syncplay starts
`--no-store` - Disable the storing of configuration data (in .syncplay file)
`--room [room]` / `-r [room]` - Specify default room to join upon connection. If no room is specified then it will use the filename of the currently playing file, or alternatively will join the default room if no file is playing.
`--password [password]` / `-p [password]` - Specify server password
`[file]` - File to play upon start
### Configuration window
The configuration window allows for various settings to be configured prior to Syncplsy starting.
@ -119,6 +97,28 @@ Within the Syncplay commandline you can enter the following commaands (and then
7. If you don't have the file you want to play open in your media player then open it from within your media player.
### Command-line switches
You can run `syncplayClient.exe` with the following command-line switches to alter Syncplay settings or behaviour:
`--no-gui` - Do not display graphical user interface (GUI)
`--host [address]` - Specify address of server to connect to (can be address:port)
`--name [name]` / `-n [name]` - Specify username to use
`--debug` / `-d` - Enable debug mode
`--force-gui-prompt` / `-g` - Force the configuration window to appear when Syncplay starts
`--no-store` - Disable the storing of configuration data (in .syncplay file)
`--room [room]` / `-r [room]` - Specify default room to join upon connection. If no room is specified then it will use the filename of the currently playing file, or alternatively will join the default room if no file is playing.
`--password [password]` / `-p [password]` - Specify server password
`[file]` - File to play upon start
### Error messages and notifications
"Rewinded due to time difference" - This means that your media player ended up too far in front of at least one other viewer and has jumped back to keep you in sync. This is usually because someone's computer isn't powerful enough to play the file smoothly.