800.885.8886 sales@telvue.com
  • Facebook
  • Twitter
  • Facebook
  • Twitter
TelVue
  • Home
  • Products
    • Playback & Automation
      • HyperCaster®
      • ProVue®
        • ProVue® HD
        • ProVue® GFX
        • ProVue® CC
      • TelVue TeleCastTM 2
    • Streaming/Cloud
      • TelVue CloudCast™
      • TelVue Connect™
      • Media Exchange
      • Mobile & OTT Apps
      • TelVue SmartCaption™
    • Digital Signage
      • TelVue InfoVue™
    • Automatic Captioning
      • SmartCaption™
    • Ad Insertion
      • TelVue AdCaster™
  • Solutions
    • Cable/Telco
    • Community Media
    • Media Companies
  • Support
    • Knowledge Base
    • Webinars
    • Training Videos
    • Documentation
    • Contact Support
  • News
    • Blog
    • Press
    • Awards
  • Client Logins
    • Connect/CloudCast
    • InfoVue
  • Contact Us
    • General & Sales
    • Technical Support
Select Page

Connect/CloudCast

Connect User Manual
  • TelVue Connect™ User Manual (v2.6)
  • Organization Settings
  • Getting Started
  • Upload and Transcode Content
  • Enter Metadata
  • Metadata Presets
  • Broadcast Server Integration
  • Distribution
  • Manage Storage Space in Connect
  • Manage User Accounts
  • Email Notifications
  • Publishing and Moderation
  • Create and Schedule Series
  • Fill a Series with Episodes
  • Create and Schedule Playlists
  • TelVue Connect Media Exchange
  • How to Syndicate Content to the Media Exchange
  • Series Syndication
  • Syndication Reports
  • SmartCaption™ Automatic Closed Captioning
  • Custom Language Models
  • SmartCaption™ Caption Translation
  • Manage CloudCast Content
  • Add Live Streams to CloudCast
  • CloudCast Video Player (Connect VOD Player)
  • Share and Embed Videos
  • Manage Connect/CloudCast Categories
  • Add Chapters
  • Add Attachments
  • CloudCast Banner Ads
  • Getting Started with Roku
  • Manage Roku App
  • Getting Started with Apple TV
  • Manage Apple TV App
  • CloudCast MRSS
  • Podcasting
  • Bulk Action Feature Requirements
  • RSS Feeds
  • TelVue Connect Contributors’ Guide (PEG version)
  • TelVue Connect Contributors’ Guide (CableLabs version)
  • Cable Option
CloudCast User Manual
  • Manage CloudCast Content
  • Add Live Streams to CloudCast
  • CloudCast Video Player (Connect VOD Player)
  • Share and Embed Videos
  • Manage Connect/CloudCast Categories
  • Add Chapters
  • Add Attachments
  • CloudCast Banner Ads
  • Getting Started with Roku
  • Manage Roku App
  • Getting Started with Apple TV
  • Manage Apple TV App
  • SmartCaption™ Automatic Closed Captioning
  • Custom Language Models
  • SmartCaption™ Caption Translation
  • CloudCast MRSS
  • CloudCast Training Videos
Media Exchange
  • How to License Content from the Media Exchange
Cloud FAQs
  • Reset Connect Password
  • Track CloudCast Views in Google Analytics
  • When should I set the transcode to “always” or “never”?
  • How much bandwidth do I need to upload to Connect?
  • If I am a program coordinator for my channel do I see all the other channels or is it limited to my channel?
  • Can a contributor submit new content to a filled timeslot?
  • Can I use TelVue Connect with multiple operators to share content?
  • Any issues with firewalls or ISP outside of the US?
  • How long does TelVue Connect take to transcode a file?
  • Can multiple videos be grouped into one schedule slot?
  • If a contributor with an assigned timeslot has their content and schedule sent to a server, can the local operator override this scheduled programming?
  • TelVue Connect is just software, right? Do we need any other hardware, then?
  • Can I use TelVue Connect but send my content to my broadcast server without being scheduled, and schedule it locally at the server?
  • Will the final “approved” version appear in the Content section of our TelVue Broadcast Server?
  • Any bandwidth concerns if contributors are submitting a lot of HD content to our HD server?
  • Can my TelVue Connect account transcode both SD and HD upon choice? Will it downconvert/crop HD to SD? Inversely, if we have a TelVue HD Server, will TelVue Connect upconvert SD content properly?
  • What is the relationship between TelVue Connect and TelVue CloudCast streaming service?
  • If I have multiple formats to upload does it automatically convert to what we have set as a default?
  • Who specifies the transcoding parameters?
  • Add a video or stream to your org’s Facebook page
Connect APIs
  • JSON REST API – version 2 – Media
  • JSON REST API – version 2 – Videos
  • JSON REST API – version 2 – Playlists
  • JSON REST API – version 2 – Playlist Items
  • JSON REST API – version 2 – Series
  • JSON REST API – version 2 – Categories
  • JSON REST API – version 2 – Roku Applications

HyperCaster

HyperCaster User Manual
    HyperCaster Configuration
    • Config Tab
    • Channel Setup
    • Continuity
    • Live Streams
    • Feed Setup
    • NDI Access Manager
    • ProVue Decoder Configuration
    • Configure In/Out Ports
    • Encode Profiles
    • Manage TeleCasts
    • Streaming Destinations
    • Streaming Rules
    • User Management
    • Content Settings
    • Pro Transcoding
    • Schedule Configuration
    • InfoVue XML
    • Switch Configuration
    • Remote Server Configuration
    • TelVue Connect Configuration
    • Captioning Configuration
    • Server Management
    • NTP, NTP Configuration, and NTP Health
    • Security Configuration
    • Network and Security
    • Setting up SSL/HTTPS on the HyperCaster
    • Backup Settings
    • IPMI
    • Config – Utilities
    • Version and Configuration
    • SNMP Support
    • External Devices
    • Brightcove EPG Integration
    • Add an RTMP Stream
    • Set Up an RTMP Stream in a HyperCaster
    • Set Up an SRT Stream in a HyperCaster
    • Set Up an HLS Stream in a HyperCaster
    • Get Channel Schedule as XML (Detailed)
    HyperCaster Content Management
    • Organize and Add Content
    • Content Management
    • Thumbnail and Table Views
    • Show Content Page
    • Content File Actions
    • Add TBD Program
    • DVD Import
    • Replacement Files Hot Folder
    • How to Trim a Video File (Virtual Trimming)
    • Trim Content (Built-in, Multiple Trim Editing)
    • Tasks
    • Previews
    • Turn On Transcoding
    • Create a HyperCaster Playlist
    • Series & Series Scheduling
    • Record or Capture
    • Upload to Connect/CloudCast
    • Archiving
    • Archive.org integration
    • Content Workflow Rules
    • Preparing Content for the HyperCaster
    • Content RSS Feed
    • Export to CSV
    • Searching
    • Using Third-Party Editing Software
    HyperCaster Programming
    • The Dashboard
    • Programming
    • Calendar View
    • Classic View
    • Search Filters and Event Functions
    • Field Descriptions and Display Options
    • Program Playout Event
    • Program Stream Event
    • Program Record Event
    • Program Input Event (AIO Only)
    • Input Locking
    • Program Switch Event
    • Scheduling a Live Switch Event whose Actual Duration Varies
    • Program Playlist Event
    • Program Overlay Event
    • Program Slide Event
    • Program Ad Trigger Event
    • Unschedule an Event
    • Event Actions
    • Copy Program Blocks
    • Import and Export events
    • Native CSV Formatting
    • Scheduling Conflicts and Ripple
    • Recurring Events
    • Controlling What Appears in the Program Guide
    • Publishing Your Schedule
    • Schedule Ads
    HyperCaster Graphics
    • Graphic Overlays
    • Overlay Rules
    • Bugs
    • Tickers
    • How to Build RSS Tickers
    • Snipes
    • Clocks
    • Program Guides
    • Emergency Notification Console
    • Join in Progress Overlay
    HyperCaster Reports
    • Reports Tab
    • As Run Reports
    • Program Guide Report
    • Missing File Report
    • TelVue Connect Report
    HyperCaster Captioning
    • SmartCaption™ Automatic Captioning Integration
    HyperCaster Streaming
    • Configure In/Out Ports
    • Streaming Destinations
    • Encode Profiles
    • Manage TeleCasts
    • Streaming Rules
    HyperCaster Miscellaneous
    • System Health
    • Backups
    • Safety Requirements
    • Glossary
    HyperCaster Guide to CCMS Plus
    • Guide to CCMS Plus
    • CCMS Plus Setup
    • CCMS Schedule Remote Directory Folder Structures
    • Schedule and Media Imports
    • Verification File Export
    • Tasks Tab
    • E-Mail Notifications of Missing Content
HyperCaster FAQs
  • How do I access the UI for my HyperCaster?
  • What is the difference between, “enable continuity” and “continuity resume”?
  • Port Forwarding Rules to Allow External Access to the HyperCaster
  • How to Stream a Zoom Meeting to the HyperCaster
  • Extending an IP Capture without Re-Entering Metadata
  • YouTube Live
  • How do I set InfoVue as Continuity on the HyperCaster?
  • How do I embed a HyperCaster Program Guide in my website?
  • Facebook Live
  • What does “ripple” mean?
  • Does the preview player under edit show timecode or full length of video?
  • What is the RSS feed button in the HyperCaster?
  • How to Add a TriCaster Feed to the HyperCaster
  • Mapping the HyperCaster to Your Desktop
  • How to display NOAA weather RSS as HyperCaster Ticker
  • How to Stream a WebEx Meeting to the HyperCaster
  • Is it possible to run a PowerPoint through my HyperCaster?
  • Why is my NTP server showing a critical status?
  • How to Add a LiveU Solo Feed to the HyperCaster
  • TelVue Server LED Status Indicators
  • On the Channel Setup page, what are the “Website Guide Details” checkbox and the “TV Guide Station ID”?
  • Go LIVE from anywhere with a JVC GY-HM200 and a HyperCaster
  • How do I display Program guide?
  • What is MPEG?
  • Prepare Content for HyperCaster with Sorensen Squeeze
  • Use OBS to Live Stream Skype, GoToMeeting, or any Application Window to Your HyperCaster
  • On the “Health” page, was does NTP define?
  • Preparing Content for your HyperCaster Using Telestream Episode Pro
  • Is it possible to run two channels to the same IP address with different ports?
  • Is it possible to run two Ethernet connections out of the HyperCaster? (Additional Card Required)
  • Are 16:9 files automatically letterboxed?
  • Server rooms: some practical advice
  • Is it possible to run background audio from a stream that is different than the video scheduled (ex. Radio Feed)?
  • I am having issues with the overlays. They schedule but won’t play.
  • Loss-of-Video Failover Protection with This Easy Trick
  • On the “Edit Content” page, what does the “Private” checkbox, Location and Contributor fields define?
  • When using FTP are we able to change the password for psguser?
HyperCaster APIs
  • TelVue HyperCaster API Docs
  • HyperCaster API Content Workflow
    • Access All Content Metadata as CSV
    • Import Content (Hot Folder)
    • Uploading Files on Schedule
    HyperCaster API Content Methods
    • Get All Content Metadata
    • Get Content Metadata by Filename (REST)
    • Get Content Metadata by ID (REST)
    • Get Content Thumbnail (REST)
    • Add Content (REST)
    • Edit Content (REST)
    • Delete Content (REST)
    • Add Content (SOAP)
    • Edit Content (SOAP)
    • Delete Content (SOAP)
    HyperCaster API Schedule Workflow
    • Access Playback (As-Run) Log
    • Import Events (Hot Folder)
    HyperCaster API Schedule Methods
    • Get Channel Next Playing (REST)
    • Get Channel Now Playing (REST)
    • Get Channel Schedule as RSS (REST)
    HyperCaster API Channel Management
    • Get Channel Settings (REST)
    HyperCaster API System Management
    • Get System Health as RSS (REST)
    • Get Software Version (REST)
    • Get Network Settings (REST)

InfoVue

InfoVue 2.0 Beginner's Guide
  • Beginner’s Guide to InfoVue Design – Intro
  • Tour of Dashboard
  • Understand the Hierarchy
  • Tour of Template Designer
  • Understanding the Data Feed Manager
  • Odds & Ends
  • Example #1: Upload, Schedule and Publish a Slideshow
  • Example #2: Design a Simple Template
  • Example #3: Add Dynamic Elements
  • Example #4: Add Dynamic Data part 1 – Server Feed
  • Example #5: Add Dynamic Data part 2 – Data Feed in a Ticker
  • Example #6: Add Dynamic Data part 3 – Data Feed in Data Grid
  • InfoVue Training Videos
InfoVue 2.0 User Manual
  • Creating User Accounts
  • Player Properties
  • Template Designer Overview
  • Ticker Designer Overview
  • Data Feed Manager
  • Upload Media to Content Library
  • Create New Playlist
  • Adding New Content to Playlist
  • Schedule a Playlist
  • Publish Content to Your Players
  • How to Restore the Default Player and Group View
  • How to Deploy Content and Programs to the Players
  • How to Generate a Preview Report
  • Advanced Player Publishing Options
  • Managing and Organizing Players
  • Player Alerts
  • Searching for Players
  • Tagging Players
  • Player and Group Window
  • How to Determine a Player’s Status
  • How to Access the Monitoring Window
  • How to Access a Player’s Analytics Report
  • The Scheduling Grid
  • Scheduling a Playlist – Introduction
  • The Scheduling Grid Layout
  • Scheduling Grid Pop-Up Menus
  • Scheduling Examples
  • Merging Playlists and Time Slots
  • Previewing your Schedule
  • The Content Library
  • Supported Content
  • Adding Content to the Library
  • Editing Media Properties
  • Searching for Content
  • Tagging Content
  • Creating Folders for your Content
  • The Playlist Window
  • Location Specific Content
  • Searching for Playlists
  • Scheduling Playlists – Advanced
  • Main Menu
  • InfoVue Training Videos
InfoVue FAQs
  • Display mp3 Title while playing
  • What if my InfoVue output is HD and my cable channel is SD?
  • How do I hide the Audio zone in my InfoVue template?
  • How to Auto-Update an InfoVue Player
  • Can I use animated gif or transparent png in InfoVue?
  • How to Edit Template Properties
  • Select Player Before Publishing
  • How to display a YouTube video
  • How to add a Twitter feed
  • How to customize date and time in template text zones
  • How to add a Facebook Feed
  • Display NOAA Weather Data
  • Understand the Media Upload Process
  • What is the INFOVUE LIBRARY?
  • Designing Title-Safe Templates
  • Does InfoVue support LIVE feeds into the player?
  • How do I change my password in InfoVue?
  • How do I loop several audio files in a single template?
  • Preview Player Setup
  • InfoVue Pro Configuration UI
  • Why does my screen flash?
  • Aspect Ratio Calculator
  • How do I add a traffic screen?
  • How do I add audio?
  • When I add an element to the playlist, why do certain elements carry over (logo, date/time, text boxes and news ticker), and others do not?
  • How do I replace the existing Data feeds and keep the original styling?
  • How do I monitor player status?
  • Adjust the Speed of a Data Feed
  • Contributor-Updated Information
  • Why can’t I drag anything into my template designer?
  • Why can’t I drag content to my playlist?
  • Can I loop a playlist forever?
  • I have an RSS feed where the title is one item ahead of the description field. How do I fix that?
  • How do I add Weather to a template?
  • What are the recommended video formats for InfoVue content?
  • How do I change the time zone?
  • Replacing Discontinued NOAA Radar Images
  • InfoVue v2.0 Upgrade Features

TeleCast 2

TeleCast 2 User Manual
  • Introduction
  • Login & Web UI
  • Dashboard
  • Encoder Settings
  • Destinations
  • Networking
  • System
  • About
  • Set Up YouTube Live on TeleCast 2
  • Set Up Facebook Live on TeleCast 2
  • Home
  • Knowledge Base
  • HyperCaster
  • HyperCaster APIs
  • TelVue HyperCaster API Docs

TelVue HyperCaster API Docs

Recent Changes

As of version 3.16.0, several APIs will require authorization in an effort to improve their security. Authorization exists in the form of a unique API Key, which must be specified each time that an API is used. Server administrators control which users are given keys, giving them the ability to provide access to the APIs only to those users that need access.

API Key Management

All API key management is done through the Web Application. From the Config Tab, select ‘Users’ to view or modify API key settings.

Obtaining Your API Key

To obtain an API key, you must first ask your administrator to give you API access. To view your key, select the Config tab and select ‘Users’. On this screen you should see your username and the API key associated with your username. Simple copy and paste this key whenever you need to use it.

NOTE: This API key is private and connected to your account. Do not share it with other users.

Changing Your API Key

If you feel the need to change your API key, such as in the event that it has been stolen, you can regenerate your key. To generate a new API key, select the Config tab and select ‘Users’. Select your name or the edit action button to bring up your Edit User page. On the right side of this page, you will see a box labeled API Settings if you have API access. Press the “Generate New Key” button to generate a new, randomized API Key. Press the Save button to accept this change, or cancel to keep your old key.

API Access Management (Admin Only)

By default, no users are given API access. API access is granted on a per user basis through the Web Application. To grant or remove API access to a user, login as an administrator, select the Config tab, and select ‘Users’. This will show you a list of users. The users that currently have API access will have API keys in line with their names. Select the user whose API access you would like to modify. From this edit user page, you can select the checkbox labeled “API Access” to grant or remove API access for this user.

API Key Use

The use of your API key is mandatory for all APIs that require authorization. The APIs that are affected are APIs that allow you to make changes to the server or content, or view detailed information about the server. Refer to individual API pages for details.

Examples

Most, though not all, of the REST APIs that require authorization can be adjusted by simply adding ?api_key=[api_key] to the end of the url. Example:
yourserver/xml/software_version?api_key=7e14204fcce1e00152b4

Content Methods that previously required a username now instead require an API key. Example:

http://myserver/content_api/new?program_code=01&program=a1test&episode_code=009&episode=e1&description=mydescription&expected_duration=30&expected_filename=AAx&location=here&contributor=mycontrib&import_datetime=2011-04-20&delete_datetime=2012-04-20&api_key=7e14204fcce1e00152b4

For specific examples, refer to the individual API pages.

Invalid API Key

If you attempt to access a protected API without an API key or with an invalid API key, you can expect a response similar to the following:

< ?xml version="1.0" encoding="utf-8" ?>

  Access Denied


Share This Article :
  • Facebook
  • Twitter
  • LinkedIn
  • Pinterest
Still stuck? How can we help?

How can we help?

Updated on May 29, 2014

PRODUCTS

  • Playback & Automation
    • HyperCaster®
    • ProVue®
      • ProVue® HD
      • ProVue® GFX
      • ProVue® CC
    • TelVue® TeleCastTM 2
  • Streaming/Cloud
    • TelVue CloudCast™
    • TelVue Connect™
    • Media Exchange
    • Mobile & OTT Apps
    • TelVue SmartCaption™
  • Digital Signage
    • TelVue InfoVue™
  • Automatic Captioning
    • SmartCaption™
  • Ad Insertion
    • AdCaster™

SUPPORT

  • Contact Support
  • Knowledge Base
  • Training Videos
  • Product Documentation

ABOUT

  • Contact Us
  • TelVue News for Hyperlocal Broadcast, PEG news, and TV Technology
  • Press Releases
  • Executive Profiles
  • Sales Team
  • Company
  • Partners

BLOG POSTS

  • FreightWaves Taps HyperCaster AIO for Flexible Ad Integration with Brightcove
  • HyperCaster Integrated Streaming & Social Streaming Automation
  • Live Dual-language Captioning, Multiple Trim Editing, and Multistreaming Automation with HyperCaster™ 8.3
  • AIO Integrated Streaming, Program Guide & Clock Overlays with HyperCaster™ 8.2
  • Channel Streaming Rights Management with HyperCaster™ 8.1
  • Facebook
  • Twitter
16000 Horizon Way, Suite 100, Mt. Laurel, NJ 08054 - TelVue Corporation ® All Rights Reserved 2020