Class: Conversant::V3::Services::VMS

Inherits:
Base
  • Object
show all
Includes:
Authorization
Defined in:
lib/conversant/v3/services/vms.rb,
lib/conversant/v3/services/vms/partner.rb,
lib/conversant/v3/services/vms/business.rb,
lib/conversant/v3/services/vms/analytics.rb,
lib/conversant/v3/services/vms/transcoding.rb,
lib/conversant/v3/services/vms/partner/business.rb,
lib/conversant/v3/services/vms/partner/analytics.rb

Overview

Video Management System (VMS) service for video processing and management

Provides comprehensive functionality for video operations including:

  • VOD (Video on Demand) transcoding management
  • Analytics for video metrics and usage
  • Business metrics for billing and reporting

Examples:

Basic usage

vms = Conversant::V3.vms(12345)

# Get transcoding jobs
jobs = vms.transcoding.jobs(page_number: 1)

# Get analytics
volume = vms.analytics.volume(startTime: '2025-01-01')

Since:

  • 1.0.0

Defined Under Namespace

Classes: Analytics, Business, Partner, Transcoding

Constant Summary

Constants included from HttpClient

HttpClient::LOGIN_URL, HttpClient::PORTAL_SESSION_REDIS_KEY, HttpClient::SSO_GW_SESSION2_REDIS_KEY

Instance Attribute Summary

Attributes inherited from Base

#customer_id, #type

Instance Method Summary collapse

Methods inherited from Base

#initialize

Methods included from HttpClient

#authenticate, #cookie_jar, #cookie_jar=, #debug_log, #request, #sso_login

Constructor Details

This class inherits a constructor from Conversant::V3::Base

Instance Method Details

#analytics ⇒ Analytics

Get analytics service instance

Returns:

  • (Analytics) —

    analytics service for video metrics

Since:

  • 1.0.0



40
41
42
 
# File 'lib/conversant/v3/services/vms.rb', line 40

def analytics
  @analytics ||= Analytics.new(self)
end

#business ⇒ Business

Get business metrics service instance

Returns:

  • (Business) —

    business service for billing metrics

Since:

  • 1.0.0



48
49
50
 
# File 'lib/conversant/v3/services/vms.rb', line 48

def business
  @business ||= Business.new(self)
end

#partner ⇒ Partner

Get partner service instance

Provides access to partner-level analytics for Video Management System that aggregate data across multiple customer accounts.

Examples:

Access partner analytics

vms = Conversant::V3.vms(12345)
transcoding = vms.partner.analytics.transcoding(payload)

Returns:

  • (Partner) —

    partner service for VMS analytics

Since:

  • 1.0.12



63
64
65
 
# File 'lib/conversant/v3/services/vms.rb', line 63

def partner
  @partner ||= Partner.new(self)
end

#partner_analytics ⇒ VMS::Partner::Analytics

Deprecated.

Use #partner instead

Get partner analytics service instance (deprecated)

Returns:

Since:

  • 1.0.8



73
74
75
 
# File 'lib/conversant/v3/services/vms.rb', line 73

def partner_analytics
  @partner_analytics ||= Partner::Analytics.new(self)
end

#transcoding ⇒ Transcoding

Get transcoding service instance

Returns:

  • (Transcoding) —

    transcoding service for job management

Since:

  • 1.0.0



32
33
34
 
# File 'lib/conversant/v3/services/vms.rb', line 32

def transcoding
  @transcoding ||= Transcoding.new(self)
end