# python-vlc-http
Pip module for sending http requests to a VLC Server
# Installation
`pip install python-vlc-http`
# How to use
```python
from python_vlc_http import HttpVLC
vlc_client = HttpVLC('host', 'username', 'password')
fullscreen_status = vlc_client.is_fullscreen()
if(fullscreen_status):
print('VLC is running on fullscreen!')
```
**NOTE:** Host follows the format of http://thisissomeaddrress.com:[PORT NUMBER HERE] else it will raise an exception!
# Methods
* `album()`
Get the album playing, if none it returns None
* `api_version()`
Return API Version of VLC Server
* `artist()`
Get the artist playing, if none it returns None
* `aspect_ratio()`
Return Aspect Ratio of media playing
* `audio_delay()`
Return Aspect Ratio of media playing
* `clear_queue()`
Clear media in queue
* `filename()`
Get the filename
* `is_fullscreen()`
Return if VLC is in fullscreen
* `is_looped()`
Return if VLC is set on loop
* `is_on_repeat()`
Return if playback is set on repeat
* `is_random()`
Return if shuffle is on or off
* `media_artist()`
Return Current Artist playing
* `media_length()`
Return the length of the media in seconds
* `media_time()`
Return how long the media file is
* `next_track()`
Play next media in queue
* `position()`
Return the position of the playback
* `previous_track()`
Play previous media in queue
* `rate()`
Return the rate
* `set_volume(volume)`
Set volume level, range 0..1.
* `shuffle()`
Set shuffle mode
* `state()`
Return the state of the media file
* `stop()`
Send stop command.
* `subtitle_delay()`
Return the set delay for subtitles
* `title()`
Get the title playing, if none it returns None
* `toggle_fullscreen()`
Toggle Fullscreen
* `track_number()`
Get the track_number playing, if none it returns None
* `volume()`
Return the volume of the media playing
* `play()`
Start playing media playback
* `pause()`
Pause playback
* `play_playlist_item`
Arguments:
* id -> The id of the playlist item you want to play
Start playing a specific item from a playlist
* `delete_playlist_item`
Delete a specific item from a playlist
Arguments:
* id -> The id of the playlist item you want to delete
* `sub_delay`
Select the subtitle delay for a video.
Arguments:
* val -> The delay for the subtitles
* `video_track`
Select the video track for a particular media file.
Arguments:
* val -> ID from the stream
* `subtitle_track`
Select the subtitle track for a video.
Arguments:
* val -> ID from the stream
* `set_rate`
Set the rate for a current media file.
Arguments:
* val -> the value of what ratee it should be
Raw data
{
"_id": null,
"home_page": "https://github.com/matejmecka/python-vlc-http",
"name": "python-vlc-http",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "VLC,HttpServer",
"author": "Matej Plavevski",
"author_email": "matej.plavevski+github@gmail.com",
"download_url": "https://pypi.org/project/python-vlc-http/",
"platform": null,
"description": "# python-vlc-http\nPip module for sending http requests to a VLC Server\n\n# Installation\n\n`pip install python-vlc-http`\n\n# How to use\n\n```python\nfrom python_vlc_http import HttpVLC\n\nvlc_client = HttpVLC('host', 'username', 'password')\n\nfullscreen_status = vlc_client.is_fullscreen()\n\nif(fullscreen_status):\n print('VLC is running on fullscreen!')\n\n```\n\n**NOTE:** Host follows the format of http://thisissomeaddrress.com:[PORT NUMBER HERE] else it will raise an exception!\n\n\n# Methods\n \n \n* `album()`\n\n Get the album playing, if none it returns None\n\n* `api_version()`\n\n Return API Version of VLC Server\n\n* `artist()`\n\n Get the artist playing, if none it returns None\n\n* `aspect_ratio()`\n\n Return Aspect Ratio of media playing\n\n* `audio_delay()`\n\n Return Aspect Ratio of media playing\n\n* `clear_queue()`\n\n Clear media in queue\n\n* `filename()`\n\n Get the filename\n\n* `is_fullscreen()`\n\n Return if VLC is in fullscreen\n\n* `is_looped()`\n\n Return if VLC is set on loop\n \n* `is_on_repeat()`\n\n Return if playback is set on repeat\n\n* `is_random()`\n\n Return if shuffle is on or off\n\n* `media_artist()`\n\n Return Current Artist playing\n\n* `media_length()`\n\n Return the length of the media in seconds\n\n* `media_time()`\n\n Return how long the media file is\n\n* `next_track()`\n\n Play next media in queue\n\n* `position()`\n\n Return the position of the playback\n\n* `previous_track()`\n\n Play previous media in queue\n\n* `rate()`\n\n Return the rate\n\n* `set_volume(volume)`\n\n Set volume level, range 0..1.\n\n* `shuffle()`\n\n Set shuffle mode\n\n* `state()`\n\n Return the state of the media file\n\n* `stop()`\n\n Send stop command.\n\n* `subtitle_delay()`\n\n Return the set delay for subtitles\n\n* `title()`\n\n Get the title playing, if none it returns None\n \n* `toggle_fullscreen()`\n\n Toggle Fullscreen\n\n* `track_number()`\n\n Get the track_number playing, if none it returns None\n\n* `volume()`\n\n Return the volume of the media playing\n \n* `play()`\n\n Start playing media playback\n\n* `pause()`\n\n Pause playback\n \n* `play_playlist_item`\n \n Arguments: \n \n * id -> The id of the playlist item you want to play\n\n Start playing a specific item from a playlist\n \n* `delete_playlist_item`\n\n Delete a specific item from a playlist\n\n Arguments: \n \n * id -> The id of the playlist item you want to delete\n \n* `sub_delay`\n\n Select the subtitle delay for a video.\n\n Arguments: \n \n * val -> The delay for the subtitles\n \n * `video_track`\n\n Select the video track for a particular media file.\n\n Arguments: \n \n * val -> ID from the stream\n \n * `subtitle_track`\n\n Select the subtitle track for a video.\n\n Arguments: \n \n * val -> ID from the stream\n \n * `set_rate`\n\n Set the rate for a current media file.\n\n Arguments: \n \n * val -> the value of what ratee it should be\n \n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python module that enables communication with the VLC http server",
"version": "0.0.11",
"split_keywords": [
"vlc",
"httpserver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d4a5b98c82e61027853c20ae89d9f08e6c88d449ae8f39d99c7a7005a326c47",
"md5": "1d5bc006b076c3cda3b01c02ca851820",
"sha256": "7ae5570c1683b7392215e628e87281aa0dbae7b5bf190dd72f6328769b397afb"
},
"downloads": -1,
"filename": "python_vlc_http-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d5bc006b076c3cda3b01c02ca851820",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5725,
"upload_time": "2023-04-20T08:20:26",
"upload_time_iso_8601": "2023-04-20T08:20:26.282268Z",
"url": "https://files.pythonhosted.org/packages/8d/4a/5b98c82e61027853c20ae89d9f08e6c88d449ae8f39d99c7a7005a326c47/python_vlc_http-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-20 08:20:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "matejmecka",
"github_project": "python-vlc-http",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "python-vlc-http"
}
JSON
