Skip to content

Commit

Permalink
docs: document device type option
Browse files Browse the repository at this point in the history
Add --device-type documentation to README and improve help text
to show available device type values.
  • Loading branch information
roderickvd committed Nov 27, 2024
1 parent b54001c commit 736977b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@ Your music will start playing on the selected device.
pleezer --name "My Deezer Player"
```

- `--device-type`: Set how the device identifies itself to Deezer clients. Affects how the device appears in Deezer apps. Options are: web (default), mobile, tablet, or desktop. Example:
```bash
pleezer --device-type mobile
```

- `-d` or `--device`: Select the output device. Use `?` to list available devices. If omitted, the system default output device is used. Examples:
```bash
# List available devices
Expand Down
1 change: 1 addition & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ struct Args {
/// Set the device type to identify as to Deezer
///
/// This affects how the device appears in Deezer apps.
/// Values: web, mobile, tablet, desktop
#[arg(long, default_value_t = DeviceType::Web, env = "PLEEZER_DEVICE_TYPE")]
device_type: DeviceType,

Expand Down

0 comments on commit 736977b

Please sign in to comment.