Documentation ¶
Index ¶
Constants ¶
const ( // AssetStatusNone captures enum value "none" AssetStatusNone string = "none" // AssetStatusError captures enum value "error" AssetStatusError string = "error" // AssetStatusFinished captures enum value "finished" AssetStatusFinished string = "finished" // AssetStatusProcessing captures enum value "processing" AssetStatusProcessing string = "processing" )
const ( // AssetTypeImage captures enum value "image" AssetTypeImage string = "image" // AssetTypeVideo captures enum value "video" AssetTypeVideo string = "video" // AssetTypeAppweb captures enum value "appweb" AssetTypeAppweb string = "appweb" // AssetTypeWeb captures enum value "web" AssetTypeWeb string = "web" )
const ( // AssetCreateStatusNone captures enum value "none" AssetCreateStatusNone string = "none" // AssetCreateStatusError captures enum value "error" AssetCreateStatusError string = "error" // AssetCreateStatusFinished captures enum value "finished" AssetCreateStatusFinished string = "finished" // AssetCreateStatusProcessing captures enum value "processing" AssetCreateStatusProcessing string = "processing" )
const ( // AssetCreateTypeImage captures enum value "image" AssetCreateTypeImage string = "image" // AssetCreateTypeVideo captures enum value "video" AssetCreateTypeVideo string = "video" // AssetCreateTypeAppweb captures enum value "appweb" AssetCreateTypeAppweb string = "appweb" // AssetCreateTypeWeb captures enum value "web" AssetCreateTypeWeb string = "web" )
const ( // AssetUpdateStatusNone captures enum value "none" AssetUpdateStatusNone string = "none" // AssetUpdateStatusError captures enum value "error" AssetUpdateStatusError string = "error" // AssetUpdateStatusFinished captures enum value "finished" AssetUpdateStatusFinished string = "finished" // AssetUpdateStatusProcessing captures enum value "processing" AssetUpdateStatusProcessing string = "processing" )
const ( // AssetUpdateTypeImage captures enum value "image" AssetUpdateTypeImage string = "image" // AssetUpdateTypeVideo captures enum value "video" AssetUpdateTypeVideo string = "video" // AssetUpdateTypeAppweb captures enum value "appweb" AssetUpdateTypeAppweb string = "appweb" // AssetUpdateTypeWeb captures enum value "web" AssetUpdateTypeWeb string = "web" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Asset ¶
type Asset struct { // Asset url // Read Only: true // Min Length: 1 AssetURL string `json:"asset_url,omitempty"` // Disable verification // // Disables HTTPS verification when set to true. DisableVerification bool `json:"disable_verification,omitempty"` // Duration // // Duration of the asset. For videos it is equal to the duration of the whole video. For web and images this field is unused - duration of the playback is controlled by the playlist. // Read Only: true Duration *float64 `json:"duration,omitempty"` // Finalized // // Indicates whether processing of the asset is finalized or not. // Read Only: true Finalized *bool `json:"finalized,omitempty"` // Folder name // // Name of the folder the asset is located in. FolderName string `json:"folder_name,omitempty"` // Headers // // HTTP headers for web assets. Headers map[string]*string `json:"headers,omitempty"` // Height // // Height of the asset. // Read Only: true Height int64 `json:"height,omitempty"` // Id // // Unique ID of the asset // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Md5 // // MD5 checksum of the asset. // Read Only: true // Min Length: 1 Md5 string `json:"md5,omitempty"` // Meta data // // // A key-value user-defined store for an asset. // {"meta_1": "meta_1 data", "meta_2": "meta_2 data"} // MetaData map[string]*string `json:"meta_data,omitempty"` // Source md5 // // MD5 checksum of the original source file. // Read Only: true SourceMd5 *string `json:"source_md5,omitempty"` // Source size // // Size of the original source file in bytes. // Read Only: true SourceSize int64 `json:"source_size,omitempty"` // Source url // // URL of the original source file. // Read Only: true // Min Length: 1 SourceURL *string `json:"source_url,omitempty"` // Status // // Indicates the current status of the asset processing // Read Only: true // Enum: [none error finished processing] Status string `json:"status,omitempty"` // Title // // Title of the asset. Title string `json:"title,omitempty"` // Type // // Type of the asset. Web, video and images are supported. // Read Only: true // Enum: [image video appweb web] Type *string `json:"type,omitempty"` // Url // // This is API URL of this asset in the following form: /v3/assets/<id> // Read Only: true URL string `json:"url,omitempty"` // Width // // Width of the asset. // Read Only: true Width int64 `json:"width,omitempty"` }
Asset asset
swagger:model Asset
func (*Asset) ContextValidate ¶
ContextValidate validate this asset based on the context it is used
func (*Asset) MarshalBinary ¶
MarshalBinary interface implementation
func (*Asset) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AssetCreate ¶
type AssetCreate struct { // Asset url // Read Only: true // Min Length: 1 AssetURL string `json:"asset_url,omitempty"` // Disable verification // // Disables HTTPS verification when set to true. DisableVerification bool `json:"disable_verification,omitempty"` // Duration // // Duration of the asset. For videos it is equal to the duration of the whole video. For web and images this field is unused - duration of the playback is controlled by the playlist. // Read Only: true Duration *float64 `json:"duration,omitempty"` // Finalized // // Indicates whether processing of the asset is finalized or not. // Read Only: true Finalized *bool `json:"finalized,omitempty"` // Folder name // // Name of the folder the asset is located in. FolderName string `json:"folder_name,omitempty"` // Headers // // HTTP headers for web assets. Headers map[string]*string `json:"headers,omitempty"` // Height // // Height of the asset. // Read Only: true Height int64 `json:"height,omitempty"` // Id // // Unique ID of the asset // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Js injection // // Custom js code, running when asset is loaded. See examples on: https://github.com/Screenly/playground/tree/master/javascript-injectors/ // Min Length: 1 JsInjection string `json:"js_injection,omitempty"` // Md5 // // MD5 checksum of the asset. // Read Only: true // Min Length: 1 Md5 string `json:"md5,omitempty"` // Meta data // // // A key-value user-defined store for an asset. // {"meta_1": "meta_1 data", "meta_2": "meta_2 data"} // MetaData map[string]*string `json:"meta_data,omitempty"` // Source md5 // // MD5 checksum of the original source file. SourceMd5 *string `json:"source_md5,omitempty"` // Source size // // Size of the original source file in bytes. SourceSize *int64 `json:"source_size,omitempty"` // Source url // // URL of the original source file. // Required: true // Min Length: 1 SourceURL *string `json:"source_url"` // Status // // Indicates the current status of the asset processing // Read Only: true // Enum: [none error finished processing] Status string `json:"status,omitempty"` // Title // // Title of the asset. Title string `json:"title,omitempty"` // Type // // Type of the asset. Web, video and images are supported. // Read Only: true // Enum: [image video appweb web] Type *string `json:"type,omitempty"` // Url // // This is API URL of this asset in the following form: /v3/assets/<id> // Read Only: true URL string `json:"url,omitempty"` // Width // // Width of the asset. // Read Only: true Width int64 `json:"width,omitempty"` }
AssetCreate asset create
swagger:model AssetCreate
func (*AssetCreate) ContextValidate ¶
ContextValidate validate this asset create based on the context it is used
func (*AssetCreate) MarshalBinary ¶
func (m *AssetCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AssetCreate) UnmarshalBinary ¶
func (m *AssetCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AssetUpdate ¶
type AssetUpdate struct { // Asset url // Read Only: true // Min Length: 1 AssetURL string `json:"asset_url,omitempty"` // Disable verification // // Disables HTTPS verification when set to true. DisableVerification bool `json:"disable_verification,omitempty"` // Duration // // Duration of the asset. For videos it is equal to the duration of the whole video. For web and images this field is unused - duration of the playback is controlled by the playlist. // Read Only: true Duration *float64 `json:"duration,omitempty"` // Finalized // // Indicates whether processing of the asset is finalized or not. // Read Only: true Finalized *bool `json:"finalized,omitempty"` // Folder name // // Name of the folder the asset is located in. FolderName string `json:"folder_name,omitempty"` // Headers // // HTTP headers for web assets. Headers map[string]*string `json:"headers,omitempty"` // Height // // Height of the asset. // Read Only: true Height int64 `json:"height,omitempty"` // Id // // Unique ID of the asset // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Js injection // // Custom js code, running when asset is loaded. See examples on: https://github.com/Screenly/playground/tree/master/javascript-injectors/ // Min Length: 1 JsInjection string `json:"js_injection,omitempty"` // Md5 // // MD5 checksum of the asset. // Read Only: true // Min Length: 1 Md5 string `json:"md5,omitempty"` // Meta data // // // A key-value user-defined store for an asset. // {"meta_1": "meta_1 data", "meta_2": "meta_2 data"} // MetaData map[string]*string `json:"meta_data,omitempty"` // Source md5 // // MD5 checksum of the original source file. // Read Only: true SourceMd5 *string `json:"source_md5,omitempty"` // Source size // // Size of the original source file in bytes. // Read Only: true SourceSize int64 `json:"source_size,omitempty"` // Source url // // URL of the original source file. // Read Only: true // Min Length: 1 SourceURL *string `json:"source_url,omitempty"` // Status // // Indicates the current status of the asset processing // Read Only: true // Enum: [none error finished processing] Status string `json:"status,omitempty"` // Title // // Title of the asset. Title string `json:"title,omitempty"` // Type // // Type of the asset. Web, video and images are supported. // Read Only: true // Enum: [image video appweb web] Type *string `json:"type,omitempty"` // Url // // This is API URL of this asset in the following form: /v3/assets/<id> // Read Only: true URL string `json:"url,omitempty"` // Width // // Width of the asset. // Read Only: true Width int64 `json:"width,omitempty"` }
AssetUpdate asset update
swagger:model AssetUpdate
func (*AssetUpdate) ContextValidate ¶
ContextValidate validate this asset update based on the context it is used
func (*AssetUpdate) MarshalBinary ¶
func (m *AssetUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AssetUpdate) UnmarshalBinary ¶
func (m *AssetUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Group ¶
type Group struct { // Id // Required: true // Min Length: 1 ID *string `json:"id"` // Name // Read Only: true // Min Length: 1 Name string `json:"name,omitempty"` // Url // Read Only: true URL string `json:"url,omitempty"` }
Group group
swagger:model Group
func (*Group) ContextValidate ¶
ContextValidate validate this group based on the context it is used
func (*Group) MarshalBinary ¶
MarshalBinary interface implementation
func (*Group) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type GroupRead ¶
type GroupRead struct { // Id // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Name // Required: true // Min Length: 1 Name *string `json:"name"` // screens // Required: true Screens []*Screen `json:"screens"` // Url // Read Only: true URL string `json:"url,omitempty"` }
GroupRead group read
swagger:model GroupRead
func (*GroupRead) ContextValidate ¶
ContextValidate validate this group read based on the context it is used
func (*GroupRead) MarshalBinary ¶
MarshalBinary interface implementation
func (*GroupRead) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type GroupWrite ¶
type GroupWrite struct { // Id // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Name // // Group name. // Min Length: 1 Name string `json:"name,omitempty"` // Screens // // // Screens in this group // in form [ // {"id": "screen1_id"}, // {"id": "screen2_id"}, // ] // Screens []interface{} `json:"screens"` // Url // Read Only: true URL string `json:"url,omitempty"` }
GroupWrite group write
swagger:model GroupWrite
func (*GroupWrite) ContextValidate ¶
ContextValidate validate this group write based on the context it is used
func (*GroupWrite) MarshalBinary ¶
func (m *GroupWrite) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GroupWrite) UnmarshalBinary ¶
func (m *GroupWrite) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlaylistItem ¶
type PlaylistItem struct { // Duration // Minimum: 0 Duration *float64 `json:"duration,omitempty"` // Id // Required: true // Min Length: 1 ID *string `json:"id"` }
PlaylistItem Assets attached to this playlist
swagger:model PlaylistItem
func (*PlaylistItem) ContextValidate ¶
ContextValidate validates this playlist item based on context it is used
func (*PlaylistItem) MarshalBinary ¶
func (m *PlaylistItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlaylistItem) UnmarshalBinary ¶
func (m *PlaylistItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlaylistListRead ¶
type PlaylistListRead struct { // Duration // Read Only: true Duration float64 `json:"duration,omitempty"` // groups Groups []*Group `json:"groups"` // Id // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Is enabled // Required: true IsEnabled *bool `json:"is_enabled"` // Predicate // Required: true // Min Length: 1 Predicate *string `json:"predicate"` // Priority // Maximum: 1 // Minimum: 0 Priority *int64 `json:"priority,omitempty"` // Title // Required: true // Min Length: 1 Title *string `json:"title"` // Url // Read Only: true URL string `json:"url,omitempty"` }
PlaylistListRead playlist list read
swagger:model PlaylistListRead
func (*PlaylistListRead) ContextValidate ¶
ContextValidate validate this playlist list read based on the context it is used
func (*PlaylistListRead) MarshalBinary ¶
func (m *PlaylistListRead) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlaylistListRead) UnmarshalBinary ¶
func (m *PlaylistListRead) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlaylistRead ¶
type PlaylistRead struct { // Assets attached to this playlist Assets []*PlaylistItem `json:"assets"` // Duration // // Duration of the playlist in seconds. It is equal to the sum of the duration of assets inside. // Read Only: true Duration float64 `json:"duration,omitempty"` // Screen groups to which this playlist is attached Groups []*Group `json:"groups"` // Id // // Unique ID of the playlist // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Is enabled // // Set to enable/disable playlist // Required: true IsEnabled *bool `json:"is_enabled"` // Predicate // // Predicate in the screenly pro format // Required: true // Min Length: 1 Predicate *string `json:"predicate"` // Priority // // Playlists with a priority of 1 suppress any scheduled playlists with a lower priority. // Maximum: 1 // Minimum: 0 Priority *int64 `json:"priority,omitempty"` // Title // // Title of the playlist // Required: true // Min Length: 1 Title *string `json:"title"` // Url // Read Only: true URL string `json:"url,omitempty"` }
PlaylistRead playlist read
swagger:model PlaylistRead
func (*PlaylistRead) ContextValidate ¶
ContextValidate validate this playlist read based on the context it is used
func (*PlaylistRead) MarshalBinary ¶
func (m *PlaylistRead) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlaylistRead) UnmarshalBinary ¶
func (m *PlaylistRead) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlaylistWrite ¶
type PlaylistWrite struct { // Assets // // // Assets attached to this playlist // in form // [ // {"id": "asset_id", "duration": 5}, // {"id": "asset2_id"} // ] // Duration is optional and set to 10 seconds by default. // Assets []interface{} `json:"assets"` // Duration // // Duration of the playlist in seconds. It is equal to the sum of the duration of assets inside. // Read Only: true Duration float64 `json:"duration,omitempty"` // Groups // // // Screen groups // to which this playlist is attached // in the following form: // [ // {"id": "group_id"}, // {"id": "group2_id"} // ] // Groups []interface{} `json:"groups"` // Id // // Identifier of the playlist // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // Is enabled // // Set to enable/disable playlist IsEnabled bool `json:"is_enabled,omitempty"` // Predicate // // Predicate in the screenly pro format. Defaults to 'TRUE' // Min Length: 1 Predicate string `json:"predicate,omitempty"` // Priority // // Playlists with a priority of 1 suppress any scheduled playlists with a lower priority. // Maximum: 1 // Minimum: 0 Priority *int64 `json:"priority,omitempty"` // Title // // Title of the playlist // Min Length: 1 Title string `json:"title,omitempty"` // Url // Read Only: true URL string `json:"url,omitempty"` }
PlaylistWrite playlist write
swagger:model PlaylistWrite
func (*PlaylistWrite) ContextValidate ¶
ContextValidate validate this playlist write based on the context it is used
func (*PlaylistWrite) MarshalBinary ¶
func (m *PlaylistWrite) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlaylistWrite) UnmarshalBinary ¶
func (m *PlaylistWrite) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Screen ¶
type Screen struct { // Coords // // Screen coordinates. // Read Only: true Coords interface{} `json:"coords,omitempty"` // Id // Required: true // Min Length: 1 ID *string `json:"id"` // Name // // Name of the screen. // Read Only: true // Min Length: 1 Name string `json:"name,omitempty"` }
Screen screen
swagger:model Screen
func (*Screen) ContextValidate ¶
ContextValidate validate this screen based on the context it is used
func (*Screen) MarshalBinary ¶
MarshalBinary interface implementation
func (*Screen) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ScreenCreate ¶
type ScreenCreate struct { // Name // // Name of the new screen // Min Length: 1 Name string `json:"name,omitempty"` // Pin // // Pin code created with registrations endpoint // Required: true // Min Length: 1 Pin *string `json:"pin"` }
ScreenCreate screen create
swagger:model ScreenCreate
func (*ScreenCreate) ContextValidate ¶
ContextValidate validates this screen create based on context it is used
func (*ScreenCreate) MarshalBinary ¶
func (m *ScreenCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ScreenCreate) UnmarshalBinary ¶
func (m *ScreenCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ScreenDetailed ¶
type ScreenDetailed struct { // Lat/Long tuple of device geolocation. Coords []float64 `json:"coords"` // Groups to which this screen is attached Groups []*Group `json:"groups"` // Hardware version // // Hardware version of the device. Currently only Raspberry Pi versions are detected HardwareVersion string `json:"hardware_version,omitempty"` // Hostname // // Unique hostname of the device, assigned by screenly // Min Length: 1 Hostname string `json:"hostname,omitempty"` // Id // // Unique ID of the screen // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // In sync // // Shows if the screen is in sync // Required: true InSync *bool `json:"in_sync"` // Is enabled // // Set to enable/disable screen // Required: true IsEnabled *bool `json:"is_enabled"` // Last ip // // IP used used by the device LastIP string `json:"last_ip,omitempty"` // Last ping // // The last time screen has pinged the server LastPing *string `json:"last_ping,omitempty"` // Last screenshot // // The last screenshot captured from the device LastScreenshot string `json:"last_screenshot,omitempty"` // Last screenshot time // // Time when last screenshot was taken LastScreenshotTime *string `json:"last_screenshot_time,omitempty"` // Load avg // // Average load of the device LoadAvg string `json:"load_avg,omitempty"` // Local ip // // Device IP in the local network LocalIP string `json:"local_ip,omitempty"` // Location // // Geographic location auto-detected for device Location string `json:"location,omitempty"` // Mac // // MAC address of the device Mac string `json:"mac,omitempty"` // Name // // Name of the screen // Required: true // Min Length: 1 Name *string `json:"name"` // Software version // // Software version of the device SoftwareVersion string `json:"software_version,omitempty"` // Status // // Current status of the screen. ONLINE/OUT OF SYNC/OFFLINE/DISABLED // Required: true // Min Length: 1 Status *string `json:"status"` // Team // // Team ID of the device // Min Length: 1 Team string `json:"team,omitempty"` // Timezone // // Timezone detected for the device Timezone string `json:"timezone,omitempty"` // Type // // Type of the screen. HARDWARE/VIRTUAL // Required: true // Min Length: 1 Type *string `json:"type"` // Uptime // // Uptime of the device Uptime string `json:"uptime,omitempty"` // Ws open // // Shows if device has a websocket connection WsOpen bool `json:"ws_open,omitempty"` }
ScreenDetailed screen detailed
swagger:model ScreenDetailed
func (*ScreenDetailed) ContextValidate ¶
ContextValidate validate this screen detailed based on the context it is used
func (*ScreenDetailed) MarshalBinary ¶
func (m *ScreenDetailed) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ScreenDetailed) UnmarshalBinary ¶
func (m *ScreenDetailed) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ScreenEndpoint ¶
type ScreenEndpoint struct { // Lat/Long tuple of device geolocation. Coords []float64 `json:"coords"` // Groups to which this screen is attached Groups []*Group `json:"groups"` // Id // // Unique ID of the screen // Read Only: true // Min Length: 1 ID string `json:"id,omitempty"` // In sync // // Shows if the screen is in sync // Required: true InSync *bool `json:"in_sync"` // Is enabled // // Set to enable/disable screen // Required: true IsEnabled *bool `json:"is_enabled"` // Last ping // // The last time screen has pinged the server LastPing *string `json:"last_ping,omitempty"` // Last screenshot // // The last screenshot captured from the device LastScreenshot string `json:"last_screenshot,omitempty"` // Name // // Name of the screen // Required: true // Min Length: 1 Name *string `json:"name"` // Status // // Current status of the screen. ONLINE/OUT OF SYNC/OFFLINE/DISABLED // Required: true // Min Length: 1 Status *string `json:"status"` // Type // // Type of the screen. HARDWARE/VIRTUAL // Required: true // Min Length: 1 Type *string `json:"type"` }
ScreenEndpoint screen endpoint
swagger:model ScreenEndpoint
func (*ScreenEndpoint) ContextValidate ¶
ContextValidate validate this screen endpoint based on the context it is used
func (*ScreenEndpoint) MarshalBinary ¶
func (m *ScreenEndpoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ScreenEndpoint) UnmarshalBinary ¶
func (m *ScreenEndpoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation