media_sidecar

package module

v0.0.0-...-eae1866 Latest Latest Go to latest Published: Jun 17, 2025 License: MIT Imports: 2 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/smartmediafiles/media.sidecar

Links

Open Source Insights

README ¶

📑 media.sidecar

Overview

media.sidecar is a specialized library within the SmartMediaFiles ecosystem. Its purpose is to define and categorize all file types and extensions related to metadata sidecar files. This library provides the necessary definitions for the main @/media library to recognize and classify sidecar files like XMP, MIE, etc.

Features

File Type Definitions: Provides a list of FileType constants for each supported sidecar format.
File Extension Definitions: Provides a list of all corresponding FileExtension constants.
Type-to-Extension Mapping: Contains the SidecarFileTypesExtensions map that links each file type to its extensions, which is then consumed by the central @/media registry.
Future-proofing: This library will be expanded to include functions for parsing and extracting metadata from sidecar files.

Installation

go get -u github.com/smartmediafiles/media.sidecar

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

⚠️ Note: This README will be updated regularly as the project progresses. Check back often for the latest information!

Documentation ¶

Constants ¶

View Source

const (
	SidecarXMP      types.FileType = "xmp"  // Adobe XMP sidecar file (XML)
	SidecarXML      types.FileType = "xml"  // XML metadata / config / sidecar file
	SidecarAAE      types.FileType = "aae"  // Apple image edits sidecar file (based on XML)
	SidecarYAML     types.FileType = "yml"  // YAML metadata / config / sidecar file
	SidecarJSON     types.FileType = "json" // JSON metadata / config / sidecar file
	SidecarText     types.FileType = "txt"  // Text config / sidecar file
	SidecarInfo     types.FileType = "nfo"  // Info text file as used by e.g. Plex Media Server
	SidecarMarkdown types.FileType = "md"   // Markdown text sidecar file
)

List of supported media.Sidecar file types.

Variables ¶

View Source

var SidecarFileTypesExtensions = maps.MapFileTypeExtensions{
	SidecarXMP:      {".xmp"},
	SidecarXML:      {".xml"},
	SidecarAAE:      {".aae"},
	SidecarYAML:     {".yml", ".yaml"},
	SidecarJSON:     {".json"},
	SidecarText:     {".txt"},
	SidecarInfo:     {".nfo"},
	SidecarMarkdown: {".md", ".markdown"},
}

SidecarFileTypesExtensions is a map of media.Sidecar file types to their file extensions.

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

file_types.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL