Skip to main content

Crate oximedia_review

Crate oximedia_review 

Source
Expand description

Collaborative review and approval workflow for OxiMedia.

This crate provides comprehensive review and approval capabilities for video content, including:

  • Frame-accurate comments and annotations
  • Real-time collaboration with multiple reviewers
  • Version comparison and tracking
  • Multi-stage approval workflows
  • Task assignment and tracking
  • Drawing tools for visual feedback
  • Notification system (email, webhook)
  • Export capabilities (PDF, CSV, EDL)

§Example

use oximedia_review::{ReviewSession, SessionConfig, AnnotationType};

// Create a review session
let config = SessionConfig::builder()
    .title("Final Cut Review")
    .content_id("video-123")
    .workflow_type(oximedia_review::WorkflowType::MultiStage)
    .build()?;

let session = ReviewSession::create(config).await?;

// Add a frame-accurate comment
session.add_comment(
    1000, // frame number
    "Please adjust color grading",
    AnnotationType::Issue,
).await?;

// Invite reviewers
session.invite_user("reviewer@example.com").await?;

Re-exports§

pub use compare::apply_compare_filter;
pub use compare::CompareFilter;
pub use compare::CompareLayout;
pub use compare::CompareResult;
pub use compare::CompareVersion;
pub use compare::DiffStats;
pub use compare::MediaComparator;
pub use compare::WipeAngle;
pub use error::ReviewError;
pub use error::ReviewResult;
pub use session::ReviewSession;
pub use timeline_note::NoteType;
pub use timeline_note::TimeRange;
pub use timeline_note::TimelineNote;
pub use timeline_note::TimelineNoteCollection;

Modules§

annotation
Media annotation tools for review workflows.
annotation_export
Annotation export: serialize annotation collections to JSON and CSV.
annotations
Media annotation system for review workflows.
approval
Approval workflow engine.
approval_workflow
Approval workflow management for review sessions.
batch_ops
Batch operations for review sessions.
change
Change request management.
comment
Frame-accurate commenting system.
comment_thread
Comment threading: status tracking, resolution, and unresolved count.
compare
Side-by-side and A/B visual comparison for media review.
comparison_mode
High-level A/B comparison mode for media review.
deadline
Review deadline tracking and enforcement.
delivery
Review delivery management.
drawing
Drawing tools and annotations for visual feedback.
error
Error types for review operations. Error types for review operations.
export
Export review data to various formats.
feedback_round
Feedback round management for iterative media review.
marker
Review markers for frame-level annotations on a timeline.
notify
Notification system.
offline_review
Offline review: download review packages and sync comments when reconnected.
realtime
Real-time collaboration features.
realtime_delta
Delta-based real-time synchronisation for annotation updates.
report
Review report: summarises comments, annotations, and markers for a session.
review_api
REST API endpoint definitions for external tool integration.
review_automation
Review automation: auto-trigger review sessions on new version uploads.
review_checklist
Review checklist: per-item completion tracking with blocking-item awareness.
review_comparator
High-level review comparison utilities.
review_diff
Content diff analysis between review iterations.
review_export
Export review session data to various formats.
review_history
Review session history tracking and audit trail.
review_link
Shareable review link generation, validation, and revocation.
review_metrics
Metrics and analytics for review sessions.
review_notification_rule
Configurable notification rules for review events.
review_permission
Fine-grained review permissions and role-based permission sets.
review_playlist
Review playlists: organize multiple clips into sequential review sessions.
review_priority
Priority management for review items and sessions.
review_session
Review session management with quorum logic and state tracking.
review_snapshot
Review snapshots: capture frame grabs with annotations baked in.
review_status
Review status tracking, state transitions, and status aggregation.
review_tag
Tagging and labelling system for review items.
review_template
Review templates for standardised review workflows.
session
Review session management.
status
Review status tracking.
task
Task assignment and tracking.
timeline_note
Temporal notes and markers for review sessions.
version
Version management and comparison.
version_compare
Version comparison and diff utilities for review workflows.
version_lazy
Lazy-loading façade for version history.

Structs§

CommentId
Unique identifier for a comment.
DrawingId
Unique identifier for a drawing/annotation.
SessionConfig
Configuration for creating a review session.
SessionConfigBuilder
Builder for SessionConfig.
SessionId
Unique identifier for a review session.
TaskId
Unique identifier for a task.
User
User information.
VersionId
Unique identifier for a version.

Enums§

AnnotationType
Type of annotation/comment.
UserRole
User role in a review session.
WorkflowType
Workflow type for review sessions.