Skip to content

TeacherTube

Julian Hangstörfer edited this page Jul 13, 2019 · 2 revisions

Supported media types:

  • 'video': Videos.
  • 'audio': Audios.
  • 'document': Documents, pdfs.
  • 'channel': A user/channel.
  • 'collection'
  • 'group'

Supported url formats:

  • 'long'(default): Regular urls.
  • 'embed': Embedded urls.

Creating urls with different media types:

mediaType/formats long embed
video
audio
document X
channel X
collection X
group X

Special parameters:

  • 'list': Playlist id.

Parsing Examples:

> urlParser.parse('https://www.teachertube.com/video/les-homophones-ces-ses-la-rgle-488055')
> urlParser.parse('https://www.teachertube.com/video/488055')
> urlParser.parse('https://www.teachertube.com/embed/video/488055')
{
    provider: 'teachertube',
    id: '488055',
    mediaType: 'video',
}

> urlParser.parse('https://www.teachertube.com/audio/11814')
> urlParser.parse('https://www.teachertube.com/embed/audio/11814')
{
    provider: 'teachertube',
    id: '11814',
    mediaType: 'audio',
}

> urlParser.parse('https://www.teachertube.com/document/36486')
{
    provider: 'teachertube',
    id: '36486',
    mediaType: 'document'
}

> urlParser.parse('https://www.teachertube.com/group/mathforkids')
{
    provider: 'teachertube',
    id: 'mathforkids',
    mediaType: 'group'
}

> urlParser.parse('https://www.teachertube.com/collection/4728')
{
    provider: 'teachertube',
    id: '4728',
    mediaType: 'collection'
}

> urlParser.parse('https://www.teachertube.com/user/channel/michaelfrancismari')
{
    provider: 'teachertube',
    id: 'michaelfrancismari',
    mediaType: 'channel'
}

> urlParser.parse('https://www.teachertube.com/user/channel/lmodgling?playlist-id=10125')
{
    provider: 'teachertube',
    id: 'michaelfrancismari',
    mediaType: 'channel'
    list: '10125'
}

Creation Examples:

> urlParser.create({
    videoInfo: {
        provider: 'teachertube',
        id: '488055',
        mediaType: 'video',
    },
    format: <format>
})
'long': 'https://www.teachertube.com/video/488055'
'embed': 'https://www.teachertube.com/embed/video/488055'

> urlParser.create({
    videoInfo: {
        provider: 'teachertube',
        id: '11814',
        mediaType: 'audio',
    },
    format: <format>
})
'long': 'https://www.teachertube.com/audio/11814'
'embed': 'https://www.teachertube.com/embed/audio/11814'


> urlParser.create({
    videoInfo: {
      provider: 'teachertube',
      id: '36486',
      mediaType: 'document'
    },
    format: <format>
})
'long': 'https://www.teachertube.com/document/36486'

> urlParser.create({
    videoInfo: {
      provider: 'teachertube',
      id: 'mathforkids',
      mediaType: 'group'
    },
    format: <format>
})
'long': 'https://www.teachertube.com/group/mathforkids'

> urlParser.create({
    videoInfo: {
      provider: 'teachertube',
      id: '4728',
      mediaType: 'collection'
    },
    format: <format>
})
'long': 'https://www.teachertube.com/collection/4728'

> urlParser.create({
    videoInfo: {
      provider: 'teachertube',
      id: 'michaelfrancismari',
      mediaType: 'channel'
    },
    format: <format>
})
'long': 'https://www.teachertube.com/user/channel/michaelfrancismari'

> urlParser.create({
    videoInfo: {
      provider: 'teachertube',
      id: 'michaelfrancismari',
      mediaType: 'channel'
      list: '10125'
    },
    format: <format>
})
'long': 'https://www.teachertube.com/user/channel/lmodgling?playlist-id=10125'