Skip to content

Settings

quickmic edited this page Oct 13, 2021 · 23 revisions

EmbyKodi_Banner

Wiki Forums Emby


Settings

Below is a description of each setting for the Emby for Kodi add-on. Each Kodi profile will have their own set of settings.

  • Emby for Kodi: Connection information
  • Sync: Syncing options, Kodi companion
  • Playback: Cinema mode, transcode options, resume and delete after playback
  • Interface: Context menu, notifications, permanent users in the session
  • Plugin: Dynamic plugin listing options
  • Advanced: Logging, device id, service options, backup

Emby for Kodi

Login method
Toggle between Manual login and Emby connect login information. You can sign into your Emby connect here if you connected manually.

Username, Server name and address
For display purpose only. This reflects the information the add-on is using to connect to Emby.

Update server information
Select this option to update the server address the add-on is using. Do not use this to connect to a different server.

Verify connection
This setting should be enabled, unless the Emby server is using a self signed certificate.

Use alternate device name
By default, the add-on reports to Emby using your Kodi set name (Kodi settings > service settings > device name).


Sync

Enable Kodi companion
The add-on uses the server plugin Kodi companion to retrieve the latest content updates since Kodi was last online.

  • Ask to proceed with the sync if update count is greater than
    This will alert you if the startup sync has a lot of updates. Adjust the number to control when it will prompt you.

Enable sync during playback
If the add-on receives content update during playback, it will process them immediately.

Allow the screensaver during syncs
Allow the screensaver and sleep mode during syncs. The sync might be interrupted otherwise.

Playback mode
This determines the type of playback used for your files. Changing mode requires a database reset.

  • Add-on (recommended)
    This playback mode is controlled by the add-on. You can direct play/direct stream/transcode and use the Emby cinema feature. It will also follow your parental access schedule if you have it enabled. This is the only mode that supports remote playback.
  • Native (direct paths)
    This playback mode is controlled by Kodi. This is suggested for maximum compatibility with certain Kodi add-ons. Limited Emby features for playback, you will only be able to direct play. Important This mode will import the direct paths to your media files as reported by Emby. Make sure the Kodi client has access to the paths before syncing.

Paging
Control the size of your requests to the server during the syncs. Imagine your are browsing your content on Emby. With the default values, you'd request to view 15 titles per tab (connection), for a total of 45 titles displayed at once. Adjust these values if the server is slow responding or crashes during syncs.

  • Max items requested (default: 15)
    The amount of content retrieved at once, in a single connection.
  • Download threads (default: 3)
    The number of connections to the server to retrieve content.

Enable label for multi-episodes
This will label multi episodes with all of the episode numbers. i.e. | # | title, title 2.

Enable artwork caching
This makes artwork display faster without having to wait for Kodi to cache artwork as you navigate your content. The web server needs to be enabled.

Enable enhanced artwork
This currently only applies for Cover Art. If you have the server plugin, control if the add-on should apply Cover Art.

Compress artwork
Decrease the quality of the artwork retrieved from Emby. Useful if you are short on disk space.

Sync empty shows
If the add-on should sync empty shows.

Sync Rotten Tomatoes ratings
Since Emby has no user rating sytem like Kodi has, we've added the option to use this information field to store the Rotten Tomatoes rating (0-100). This replaces the Kodi internal user rating system (1-10). Depending on the used skin it's possible to manipulate this setting on the Kodi end and to overwrite it with your own rating, but this won't be synced back to Emby.


Playback

For add-on playback only

Simple play
This setting makes playback resolved to a single item to play, ignoring cinema mode and additional parts. This allows compatibility with external players.

Enable cinema mode
This enables playback of trailers before the main content. You can find more information in your server dashboard > Playback > Cinema Mode.

  • Ask to play trailer
    Optional prompt to skip trailers.

Force HTTP playback
Play the file over HTTP, which is provided to Kodi by Emby. Useful if you have path issues. If the bitrate allows for it, there will be no modifications to the file, direct playing over HTTP.

  • Force transcode
    Always transcode your content regardless of the bitrate.

Transcode H265/HEVC
Force transcode H265/HEVC content.

Transcode 10-bit (H264 and H265/HEVC)
Force transcode high10 or main10 content.

Transcode Divx/Xvid
Force transcode msmpeg4v3 or mpeg4 content.

Transcode Dvd
Force transcode mpeg2 content.

Play remote urls using Emby
If your server returns a remote url to be played, this will force it to direct stream or transcode.

Enable external subtitles
Attach external subtitles to video content.

Enable audio/subtitles selection
If you are transcoding, you can select the audio and subtiltes stream before playback starts. If this is disabled, it will select the default streams as detected using your Emby user settings (Emby web client > Playback and Subtitles settings).

Video quality (default: 100.0 Mbps HD)
Adjust the bitrate for HTTP playback. This has a direct effect on Force HTTP playback and transcode.

For native and add-on playback

Jump back on resume (in seconds)
This adjusts your resume point in Kodi.

Offer delete after playback (Movies, Episodes)
Offer to delete content after playback, if the content is considered watched.


Interface

Enable the context menu
Display Emby context menu options.

  • Enable the option to transcode
    Display the Emby transcode entry.
  • Enable the option to delete
    Display the option to delete content.
    • Skip the delete confirmation (Use at your own risk)

Permanent users
Add additional users to the Emby session. The watched status of content playing will be shared with all additional users. Follow this format for multiple users: "Username1,Username2" (no space between usernames, separated by a comma)

Display hidden users in selection
When adding additional users to the Emby session, display or hide hidden users from the selection.

Enable welcome, server offline, server restart messages
Display appropriate notifications.

Display message
For when the Emby server admin sends a message to display in Kodi.

Display the progress bar if update count greater than
Display the sync progress bar when processing updates.

Enable new content (Video, Music)
Display a notification when new content is added to Kodi.


Plugin

For dynamic listings only

Ignore specials in next episodes
Do not display special episodes in the next up listing.

Include people
Retrieve people information, this will make dynamic listings load slower.


Advanced

Log level
Turn on logging for troubleshooting. This should be set to info, unless you are troubleshooting. Having this set to debug may slow down the add-on. Refer to How to report an issue

Mask sensitive information in log
Hide server address and tokens in the add-on logging. This has no effect on Kodi's internal logging system.

Reset local Kodi database
Wipe your Kodi database clean and other Emby files created by the add-on. This option will also allow you to reset your Emby add-on settings.

Generate a new device Id
Generate a new unique Id to represent your Kodi device in Emby. If you copy Kodi userdata setup between devices, you'll need to trigger this on your new device so Emby can properly detect your devices.

Enable Emby for Kodi
Toggle the Emby for Kodi service internally.

Restart Emby for Kodi
Restart the Emby for Kodi service. This will rerun all startup events without exiting Kodi.

Startup delay (in seconds)
Delay the add-on from loading for x seconds. This is useful to give time for your server to wake up.

Check for updates
Check if there's a new patch available for Emby for Kodi.

Reset patch update
This displays the current patch number. In case something goes wrong after applying a new patch, this will delete the current patch content and re-download it.

Developer mode
Do not enable unless you know what you are doing. Only for testing purposes. Restart the Emby for Kodi service after enabling to apply bleeding edge patches.

Backup folder
Backup your Emby for Kodi setup. This includes your database files and your addon_data files. For more information, see Create and restore from backup