Browse Source

add emby docs

pull/202/head
Jason Dove 5 years ago
parent
commit
9291a6b6ed
  1. 1
      README.md
  2. BIN
      docs/images/emby-api-key.png
  3. BIN
      docs/images/emby-create-api-key-button.png
  4. BIN
      docs/images/emby-libraries-synchronize-switch.png
  5. BIN
      docs/images/emby-media-source-edit-libaries-icon.png
  6. BIN
      docs/images/emby-media-source-edit-path-replacements-icon.png
  7. BIN
      docs/images/emby-media-source-path-replacements.png
  8. 63
      docs/user-guide/add-media-items.md

1
README.md

@ -16,6 +16,7 @@ Want to join the community or have a question? Join us on [Discord](https://disc @@ -16,6 +16,7 @@ Want to join the community or have a question? Join us on [Discord](https://disc
- [Hardware-accelerated transcoding](#Hardware-Transcoding) options (QSV, NVENC, VAAPI)
- [Plex](https://www.plex.tv/) media and metadata
- [Jellyfin](https://jellyfin.org/) media and metadata
- [Emby](https://emby.media/) media and metadata
- Music video libraries
## Planned Features

BIN
docs/images/emby-api-key.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
docs/images/emby-create-api-key-button.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

BIN
docs/images/emby-libraries-synchronize-switch.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/images/emby-media-source-edit-libaries-icon.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

BIN
docs/images/emby-media-source-edit-path-replacements-icon.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

BIN
docs/images/emby-media-source-path-replacements.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

63
docs/user-guide/add-media-items.md

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
ErsatzTV needs to know about your media items in order to create channels.
Three library kinds are currently supported: [Local](#local-libraries), [Plex](#plex-libraries) and [Jellyfin](#jellyfin-libraries).
Four library kinds are currently supported: [Local](#local-libraries), [Plex](#plex-libraries), [Jellyfin](#jellyfin-libraries) and [Emby](#emby-libraries).
## Local Libraries
@ -127,6 +127,67 @@ Click `Save Changes` after you have created all needed path replacements. @@ -127,6 +127,67 @@ Click `Save Changes` after you have created all needed path replacements.
![Jellyfin Path Replacements](../images/jellyfin-media-source-path-replacements.png)
## Emby Libraries
Emby libraries provide a way to synchronize your media (metadata) from Emby to ErsatzTV. This synchronization process is one-way: changes made within Emby are synchronized to ErsatzTV. ErsatzTV will never make any modifications to your Emby configuration or media.
### Metadata
With Emby libraries, Emby provides all metadata.
### Add Media Items
#### Connect to Server
Connecting to a Emby server requires two settings: the server address and an api key.
##### Server Address
The server address is the address that you type in your web browser to access your Emby server.
##### API Key
To create a Emby API Key, from the `Admin / Manage Emby Server` in Emby, select `Advanced / API Keys` and click the `+ New Api Key` button near the top.
![Emby Create API Key Button](../images/emby-create-api-key-button.png)
Give the API Key a name like `ErsatzTV` and click `Ok`. The API key is then displayed.
![Emby API Key](../images/emby-api-key.png)
##### Configuration
Finally, in ErsatzTV, under `Media Sources` > `Emby` click the `Connect Emby` button, enter the `Address` and `Api Key` and click `Save Changes` to connect to your Emby server.
#### Synchronize Libraries
After connecting, select which libraries you would like to synchronize from Emby to ErsatzTV by clicking the `Edit Libraries` button for the desired Emby server.
![Emby Edit Libraries Icon](../images/emby-media-source-edit-libaries-icon.png)
In the libraries listing, click the `Synchronize` switch for all libraries you would like to synchronize from Emby to ErsatzTV, and click the `Save Changes` button to start the synchronization process.
![Emby Libraries Synchronize Switch](../images/emby-libraries-synchronize-switch.png)
### Path Replacements
Media items are not streamed from Emby media sources. Instead, ErsatzTV will attempt to play media items from disk using the same path that Emby uses to play the media item.
There are two ways to make this work:
1. Ensure ErsatzTV has access to exactly the same shares and mounts as Emby
2. Configure path replacements to tell ErsatzTV where it should look on its file system for a given Emby folder
Option 1 is recommended as it will "just work" without any further configuration.
To configure path replacements for a Emby media source, click the `Edit Path Replacements` button in the
![Emby Edit Path Replacements Icon](../images/emby-media-source-edit-path-replacements-icon.png)
Click `Add Path Replacement` to add a new path replacement, and enter the `Emby Path` along with the equivalent `Local Path` for ErsatzTV.
Click `Save Changes` after you have created all needed path replacements.
![Emby Path Replacements](../images/emby-media-source-path-replacements.png)
## Collections
ErsatzTV does not schedule individual media items; only collections of items can be scheduled.

Loading…
Cancel
Save