Lib.rs

› Web programming
#api-client #tv #server-client #japanese #open-api #server-api #mirakurun

mirakurun_client

A Rust client library for Mirakurun

by maleicacid, OpenAPI Generator team and contributors

9 releases

3.9.0-rc.2.4 Mar 21, 2023
3.9.0-rc.2.3 Mar 19, 2023
3.9.0-rc.2.2 Jan 28, 2023
3.9.0-rc.2.1 Nov 12, 2022
0.1.0 Oct 25, 2021

#721 in Web programming

Apache-2.0

135KB
2.5K SLoC

Rust API client for mirakurun_client

DVR Tuner Server for Japanese TV.

For more information, please visit https://chinachu.moe/

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 3.9.0-rc.2
  • Package version: 3.9.0-rc.2
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named mirakurun_client and add the following to Cargo.toml under [dependencies]:

mirakurun_client = { path = "./mirakurun_client" }

Documentation for API Endpoints

All URIs are relative to http://localhost:40772/api

Class Method HTTP request Description
ChannelsApi get_channel GET /channels/{type}/{channel}
ChannelsApi get_channel_stream GET /channels/{type}/{channel}/stream
ChannelsApi get_channels GET /channels
ChannelsApi get_channels_by_type GET /channels/{type}
ChannelsApi get_service_by_channel GET /channels/{type}/{channel}/services/{id}
ChannelsApi get_service_stream_by_channel GET /channels/{type}/{channel}/services/{id}/stream
ChannelsApi get_services_by_channel GET /channels/{type}/{channel}/services
ConfigApi channel_scan PUT /config/channels/scan Channel Scan
ConfigApi get_channels_config GET /config/channels
ConfigApi get_server_config GET /config/server
ConfigApi get_tuners_config GET /config/tuners
ConfigApi update_channels_config PUT /config/channels
ConfigApi update_server_config PUT /config/server
ConfigApi update_tuners_config PUT /config/tuners
EventsApi get_events GET /events
EventsApi get_events_stream GET /events/stream
IptvApi iptv_discover_json_get GET /iptv/discover.json IPTV - Media Server Support
IptvApi iptv_lineup_json_get GET /iptv/lineup.json IPTV - Media Server Support
IptvApi iptv_lineup_status_json_get GET /iptv/lineup_status.json IPTV - Media Server Support
IptvApi iptv_playlist_get GET /iptv/playlist IPTV - M3U Playlist
IptvApi iptv_xmltv_get GET /iptv/xmltv IPTV - XMLTV EPG Data
LogApi get_log GET /log
LogApi get_log_stream GET /log/stream
MiscApi restart PUT /restart Restart Mirakurun
ProgramsApi get_program GET /programs/{id}
ProgramsApi get_program_stream GET /programs/{id}/stream
ProgramsApi get_programs GET /programs
ServicesApi get_logo_image GET /services/{id}/logo
ServicesApi get_service GET /services/{id}
ServicesApi get_service_by_channel GET /channels/{type}/{channel}/services/{id}
ServicesApi get_service_stream GET /services/{id}/stream
ServicesApi get_service_stream_by_channel GET /channels/{type}/{channel}/services/{id}/stream
ServicesApi get_services GET /services
ServicesApi get_services_by_channel GET /channels/{type}/{channel}/services
StatusApi get_status GET /status Get Status
StreamApi get_channel_stream GET /channels/{type}/{channel}/stream
StreamApi get_events_stream GET /events/stream
StreamApi get_log_stream GET /log/stream
StreamApi get_program_stream GET /programs/{id}/stream
StreamApi get_service_stream GET /services/{id}/stream
StreamApi get_service_stream_by_channel GET /channels/{type}/{channel}/services/{id}/stream
TunersApi get_tuner GET /tuners/{index}
TunersApi get_tuner_process GET /tuners/{index}/process Get Tuner Process Info
TunersApi get_tuners GET /tuners
TunersApi kill_tuner_process DELETE /tuners/{index}/process Kill Tuner Process
VersionApi check_version GET /version
VersionApi update_version PUT /version/update

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

maleicacid (kazukuro0824+dev@gmailDOTcom)

Dependencies

~5–17MB
~246K SLoC