Categorygithub.com/droff/filespot
modulepackage
1.0.0
Repository: https://github.com/droff/filespot.git
Documentation: pkg.go.dev

# README

Filespot

Filespot is a Go client library for accessing the platformcraft.ru API.

platformcraft.ru API docs: https://doc.platformcraft.ru/filespot/api/

###TODO

  • pagination
  • query params

# Functions

CheckResponse checks response for errors.
DoClientRequest submits request.
NewClient returns client API.

# Structs

Client manages communication with platformcraft API.
Download represents a platformcraft Download.
DownloadCli handles communication with API.
DownloadCreateParams identifies as query params of Create request.
DownloadTasksCli handles communication with API.
ErrorResponse handles API errors.
File represents a platformcraft Record File.
Link represents a platformcraft temporary Link.
LinkCreateRequest identifies Link for the Create request.
Object represents a platformcraft Object.
ObjectAdvanced of Object.
ObjectAudioStream of Object.
ObjectCreateRequest identifies Object for the Create request.
ObjectFormat of Object.
ObjectsCli handles communication with API.
ObjectsListParams identifies as query params of List request.
ObjectUpdateRequest identifies Object for the Update request.
ObjectVideoStream of Object.
Paging represents pagination.
Player represents a platformcraft Player.
PlayerCreateRequest identifies Player for the Create request.
PlayersCli handles communication with API.
PlayerUpdateRequest indentifies Player for the Update request.
Preset represents a platformcraft Preset.
Record represents a platformcraft Record.
SecureLink represents a platformcraft Secure Link.
SecureLinkRequest identifies data for Secure request.
Storage represents a platformcraft Storage.
StorageCli handles communication with API.
Stream represents a platformcraft Stream.
StreamCreateRequest identifies Stream for the Create request.
StreamsCli handles communication with API.
StreamStartRequest identifies streaming process for the Start request.
Task represents a platformcraft Task.
TempCli handles communication with API.
TempListParams identifies as query params of List request.
Transcoder represents a platformcraft Transcoder.
TranscoderCli handles communication with API.
TranscoderConcatRequest identifies params for the Concat request.
TranscoderCreateRequest identifies params for the Create request.
TranscoderHLSRequest identifies params for the HLS request.
TranscoderTasksCli handles communication with API.

# Interfaces

DownloadService implements interface with API /download endpoint.
DownloadTasksService implements interface with API /download_tasks endpoint.
ObjectsService implements interface with API /objects endpoint.
PlayersService implements interface with API /players endpoint.
StorageService implements interface with API /storage endpoint.
StreamsService implements interface with API /streams endpoint.
TempService implements interface with API /temp endpoint.
TranscoderService implements interface with API /transcoder endpoint.
TranscoderTasksService implements interface with API /transcoder_tasks endpoint.

# Type aliases

Geo represents platformcraft `geo` type It's a map of `map[continent]map[country]true` Keys `continent` and `country` are ISO codes of continents and counties (e.g, EU и RU).