Skip to content

docs: correct readme on MediaControlOptions #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: correct readme on MediaControlOptions #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,11 +322,11 @@ No config options.

| Function | Description | Return type | Supported OS |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `play` | Plays the media session. Affects the current media session, unless `MediaControlOptions.sessionId` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `pause` | Pauses the media session. Affects the current media session, unless `MediaControlOptions.sessionId` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `togglePlayPause` | Toggles between playing/pausing the media session. Affects the current media session, unless `MediaControlOptions.sessionId` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `next` | Skips to the next track. Affects the current media session, unless `MediaControlOptions.sessionId` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `previous` | Skips to the previous track. Affects the current media session, unless `MediaControlOptions.sessionId` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `play` | Plays the media session. Affects the current media session, unless `MediaControlOptions.session_id` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `pause` | Pauses the media session. Affects the current media session, unless `MediaControlOptions.session_id` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `togglePlayPause` | Toggles between playing/pausing the media session. Affects the current media session, unless `MediaControlOptions.session_id` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `next` | Skips to the next track. Affects the current media session, unless `MediaControlOptions.session_id` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |
| `previous` | Skips to the previous track. Affects the current media session, unless `MediaControlOptions.session_id` is specified. <br><br> **Parameters:**<br>`options`: _`MediaControlOptions \| undefined`_ Additional options.<br> | `Promise<void>` | <img src="https://github.com/glzr-io/zebar/assets/34844898/568e90c8-cd32-49a5-a17f-ab233d41f1aa" alt="microsoft icon" width="24"> |

#### Related types

Expand All @@ -350,7 +350,7 @@ No config options.

| Variable | Description | Return type |
| ------------------ | ----------------------------- | ----------------------- |
| `sessionId` | ID of the session to control. If `undefined`, the current session is used. | `string \| undefined` |
| `session_id` | ID of the session to control. If `undefined`, the current session is used. | `string \| undefined` |

### Memory

Expand Down