| domain | shortname | name | status | editor | contributors | |
|---|---|---|---|---|---|---|
rfc.opencannabis.info |
4/OCS-M |
OpenCannabis Media Extension |
raw |
Sam Gammon <[email protected]> |
|
- Version
1.0 - Status:
RAW
This memo defines an extension for the core OpenCannabis Specification, version 1, that provides structures and definitions related to the expression of digital media (to include: images, videos, documents, audio, and more). Distribution of this memo is unlimited.
This specification's current status is considered RAW, i.e. pre-DRAFT.
This document describes an extension to the OpenCannabis Specification, version 1, that introduces digital-media- related definitions and structures.
"Digital media," in this context, refers to:
- Images
- Video
- Audio
- Documents
- Raw data
- Protocol Definition:
media: Images, video, documents, etc. - Copyright & Licensing
###opencannabis.media
Specifies a type of media, device orientation, file-type and so on
{% nomnoml %}
#fill: #d5e7ee; #8ebff2 [MediaOrientation | UP:0 | DOWN:1 | LEFT:2 | RIGHT:3 | UP_MIRRORED:4 | DOWN_MIRRORED:5 | LEFT_MIRRORED:6 | RIGHT_MIRRORED:7]
[MediaKey | id: string]
[DocumentType | kind: DocumentType.DocumentKind | compressed: bool]
[ImageType | kind: ImageType.ImageKind]
[MediaType | kind: MediaType.Kind | image_type: ImageType | document_type: DocumentType | video_type: VideoType]
[VideoType | kind: VideoType.VideoKind]
{% endnomnoml %}
{% nomnoml %}
#fill: #d5e7ee; #8ebff2 [DocumentType: | TXT: 0 | HTML: 1 | PDF: 2 | MARKDOWN: 3]
[ImageKind | PNG: 0 | JPG: 1 | GIF: 2 | SVG: 3 | WEBP: 4]
[MediaType | LINK: 0 | IMAGE: 1 | DOCUMENT: 2 | VIDEO: 3]
[VideoType | MP4: 0 | FLV: 1 | HLS: 2]
[MediaItem | key: MediaKey | type: MediaType | name: string | uri: string] {% endnomnoml %}
Orientation status of a piece of media. Provided by camera operations on mobile devices, in some cases, and also stored along with media sometimes.
| Name | Number | Description |
|---|---|---|
| UP | 0 | Media is oriented 'up'. |
| DOWN | 1 | Media is oriented 'down'. |
| LEFT | 2 | Media is oriented 'left'. |
| RIGHT | 3 | Media is oriented 'right'. |
| UP_MIRRORED | 4 | Media is oriented 'up,' and mirrored. |
| DOWN_MIRRORED | 5 | Media is oriented 'down,' and mirrored. |
| LEFT_MIRRORED | 6 | Media is oriented 'left,' and mirrored. |
| RIGHT_MIRRORED | 7 | Media is oriented 'right,' and mirrored. |
Key uniquely describing an item of media known to the system. An "item of media" can be anything from an image or a video, to a PDF document, or larger data.
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | Unique ID for this media item. |
Specifies document type information.
| Field | Type | Label | Description |
|---|---|---|---|
| kind | DocumentType.DocumentKind | Specifies the kind of document being attached or described. | |
| compressed | bool | Specifies whether the attached document is compressed or not. |
Specifies image type information.
| Field | Type | Label | Description |
|---|---|---|---|
| kind | ImageType.ImageKind | Specifies the format of the attached or described image. |
Specifies the type of media being attached or described.
| Field | Type | Label | Description |
|---|---|---|---|
| kind | MediaType.Kind | Specifies the generic kind of media being described or attached. | |
| image_type | ImageType | Specifies content for an image-based media item. | |
| document_type | DocumentType | Specifies content for a document-based media item. | |
| video_type | VideoType | Specifies content for a video-based media item. |
Specifies video type information.
| Field | Type | Label | Description |
|---|---|---|---|
| kind | VideoType.VideoKind | Specifies the kind of video being attached or described. |
Specifies kinds of documents that may be attached or described.
| Name | Number | Description |
|---|---|---|
| TXT | 0 | Plaintext format. |
| HTML | 1 | HTML format. |
| 2 | PDF format. | |
| MARKDOWN | 3 | Markdown format. |
Specifies kinds of images that may be attached or described.
| Name | Number | Description |
|---|---|---|
| PNG | 0 | PNG image. |
| JPG | 1 | JPG image. |
| GIF | 2 | GIF image. |
| SVG | 3 | SVG image. |
| WEBP | 4 | WEBP image. |
Enumerates, in generic terms, the kinds of media that can be attached or described.
| Name | Number | Description |
|---|---|---|
| LINK | 0 | Web link, or URI. |
| IMAGE | 1 | Image or photograph. |
| DOCUMENT | 2 | Document or text data. |
| VIDEO | 3 | Video data. |
Specifies kinds of videos that may be attached or described.
| Name | Number | Description |
|---|---|---|
| MP4 | 0 | MP4 video. |
| FLV | 1 | Flash video. |
| HLS | 2 | HTTP Live Streaming video. |
Describes an individual media item, which can be an image, video, etc.
| Field | Type | Label | Description |
|---|---|---|---|
| key | MediaKey | Key uniquely identifying this media item. | |
| type | MediaType | Type of media this is describing. | |
| name | string | Friendly name for this media. | |
| uri | string | Absolute URI to this media. |
Copyright (©) 2018, the OpenCannabis Editor and Contributors. All rights reserved.
This Specification is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This Specification is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, see http://www.gnu.org/licenses.