Images

Configuring images and image processing

Enable Images

This can be true or false, if this is set to true, images will work and it will try to directly use your Jellyfin URL to display the image (provided imgur_images and litterbox_images are both false, which they are by default). If your Jellyfin instance is not hosted on the public internet, the images will fail to display. If this is the case, you can use the options documented below.

Example

{
  "images": {
    "enable_images": true
  }
}

Imgur Images

Depends on images.enable_images, images.imgur_images being set to true and imgur.client_id being set. You

This can be true or false, if this is set to true it will use an Imgur URL for the image instead of your Jellyfin URL.

Imgur is a public image hosting service which allows you to host images without a server. In this case we can use it to display the cover image of your currently playing media without exposing your Jellyfin instance to the public internet.

Example

{
  "images": {
    "enable_images": true,
    "imgur_images": true
  },
  "imgur": {
    "client_id": "<your-imgur-client-id>"
  }
}

Litterbox Images

Depends on images.enable_images and images.litterbox_images being set to true.

This can be true or false, if this is set to true it will use a Litterbox URL for the image instead of your Jellyfin URL.

Litterbox is a public image hosting service which acts as temporary file storage. This allows us to display the cover image of your currently playing media without exposing your Jellyfin instance to the public internet. When images.litterbox_images is set to true, your cover images will stay up for 3 days, after which they are deleted. jellyfin-rpc automatically detects if an image has expired and re-uploads it if necessary.

Example

{
  "images": {
    "enable_images": true,
    "litterbox_images": true
  }
}

Process Images

Depends on images.enable_images and either images.imgur_images or images.litterbox_images being set to true.

This option will perform light image processing before uploading to your selected image host. The processing comes in the form of scaling the image to fit Discord's 1:1 aspect ratio for RPC images, as well as creating a blurred background for any area of the canvas that are otherwise empty. The following screenshot examples demonstrate the feature:

{
  "images": {
    "process_images": false
  }
}

{
  "images": {
    "process_images": true
  }
}

If no third-party image host is set, this process will not run, as Jellyfin is only intended to host its own images.

Image customization

You can change the appearance of the processed images by adding certain parameters to the images property, examples are shown below:

Default

{
  "images": {
    "bg": true,
    "bg_blur": 3
  }
}

Reduced image size

{
  "images": {
    "size": 512,
    "bg": true,
    "bg_blur": 3
  }
}

Increased blur value

{
  "images": {
    "size": 512,
    "bg": true,
    "bg_blur": 15
  }
}

Disabled background, default corner radius

{
  "images": {
    "size": 512,
    "bg": false,
    "corner_radius": 4
  }
}

Increased corner radius

{
  "images": {
    "size": 512,
    "bg": false,
    "corner_radius": 10
  }
}

No rounded corners

{
  "images": {
    "size": 512,
    "bg": false,
    "corner_radius": 0
  }
}